Software service platform

ABSTRACT

Some embodiments of the present disclosure may relate generally to platforms for providing software services. Other embodiments may be disclosed and/or claimed.

CROSS REFERENCE TO RELATED APPLICATIONS

The present application claims international priority under 35 U.S.C. §119 to co-pending Indian Patent Application No. 201941014453, filed Apr.10, 2019, entitled “SOFTWARE SERVICE PLATFORM”, the entire content anddisclosure of which is hereby incorporated by reference in its entirety.

BACKGROUND

Increasingly, many users utilize software services provided by a numberof different software service platforms. For example, enterpriseresource planning (“ERP”) systems help businesses collect informationrelating to their operations, such as production, resource management,inventory management, sales, delivery, billing, and other operations.Similarly, accounting software applications help businesses with theiraccounting information, such as payroll, purchase orders, accountspayable, sales invoices, accounts receivable, and so on.

However, software service platforms often cannot provide all thecustomized services needed by users, particularly if the users are indifferent fields. For example, users from business entities in differentindustries may need for ERP, accounting software, security software, andother software services, but the specifics of providing such servicesfor a particular user or entity may vary significantly. Embodiments ofthe present disclosure address these and other issues by providingsoftware platforms that can be efficiently and intuitively accessed andcustomized to suit the needs of individual entities.

BRIEF DESCRIPTION OF THE DRAWINGS

In the drawings, which are not necessarily drawn to scale, like numeralsmay describe similar components in different views. Like numerals havingdifferent letter suffixes may represent different instances of similarcomponents. Some embodiments are illustrated by way of example, and notlimitation, in the figures of the accompanying drawings in which:

FIG. 1 is a block diagram showing an example of a system according tovarious embodiments of the present disclosure.

FIG. 2 is a flow diagram of an exemplary process according to variousembodiments of the disclosure.

FIG. 3 depicts an exemplary functional block diagram according tovarious embodiments of the present disclosure.

FIGS. 4A and 4B depict exemplary functional block diagrams ofconventional systems.

FIGS. 5 and 6 depict exemplary functional block diagrams of systemsaccording to various embodiments of the present disclosure.

FIGS. 7A, 7B, and 7C are functional diagrams according to variousembodiments of the present disclosure.

FIGS. 7D-7S depict examples of user interfaces according to variousembodiments of the present disclosure.

FIG. 8 is a block diagram illustrating an exemplary softwarearchitecture which may be used in conjunction with various hardwarearchitectures herein described.

FIG. 9 is a block diagram illustrating components of an exemplarycomputer system according to some exemplary embodiments, which may readinstructions from a machine-readable medium (e.g., a non-transitorycomputer-readable medium) and perform any one or more of the processesand methodologies discussed herein.

DETAILED DESCRIPTION

The description that follows includes systems, methods, techniques,instruction sequences, and computing machine program products thatembody illustrative embodiments of the disclosure. In the followingdescription, for the purposes of explanation, numerous specific detailsare set forth in order to provide an understanding of variousembodiments of the inventive subject matter. It will be evident,however, to those skilled in the art, that embodiments of the inventivesubject matter may be practiced without these specific details. Ingeneral, well-known instruction instances, protocols, structures, andtechniques are not necessarily shown in detail.

FIG. 1 is a block diagram showing an exemplary system 100 for exchangingdata over a network. In this example, the system 100 includes multipleclient devices 102, each of which that may host a number ofapplications. In this context, a “client device” may refer to anymachine that interfaces to a communications network to obtain resourcesfrom one or more server systems or other client devices. A client devicemay be, but is not limited to, a mobile phone, a desktop computer, alaptop, a portable digital assistant (PDA), a smart phone, a tablet, anultra book, a netbook, a multi-processor system, a microprocessor-basedor programmable consumer electronics device, a game console, a set-topbox, or any other communication device that a user may use to access anetwork.

Each client device 102 may communicate and exchange data with otherclient devices 102, as well as with server system 108 via the network106. Such data may include functions (e.g., commands to invokefunctions) as well as payload data (e.g., text, audio, video or othermultimedia data). In this context, the network 106 may be, or include,one or more portions of a network such as an ad hoc network, anintranet, an extranet, a virtual private network (VPN), a local areanetwork (LAN), a wireless LAN (WLAN), a wide area network (WAN), awireless WAN (WWAN), a metropolitan area network (MAN), the Internet, aportion of the Internet, a portion of the Public Switched TelephoneNetwork (PSTN), a plain old telephone service (POTS) network, a cellulartelephone network, a wireless network, a Wi-Fi® network, another type ofnetwork, or a combination of two or more such networks. For example, anetwork or a portion of a network may include a wireless or cellularnetwork and the coupling may be a Code Division Multiple Access (CDMA)connection, a Global System for Mobile communications (GSM) connection,or other type of cellular or wireless coupling. In this example, thecoupling may implement any of a variety of types of data transfertechnology, such as Single Carrier Radio Transmission Technology(1×RTT), Evolution-Data Optimized (EVDO) technology, General PacketRadio Service (GPRS) technology, Enhanced Data rates for GSM Evolution(EDGE) technology, third Generation Partnership Project (3GPP) including3G, fourth generation wireless (4G) networks, Universal MobileTelecommunications System (UMTS), High Speed Packet Access (HSPA),Worldwide Interoperability for Microwave Access (WiMAX), Long TermEvolution (LTE) standard, others defined by various standard settingorganizations, other long range protocols, or other data transfertechnology.

The server system 108 provides server-side functionality via the network106 to one or more client devices (102). While certain functions of thesystem 100 are described herein as being performed by either a clientdevice 102 or by the server system 108, it will be appreciated that somefunctionality may be interchangeably performed by either the clientdevice 102 or by the server system 108. For example, it may betechnically preferable to initially deploy certain technology andfunctionality within the server system 108, but later migrate thistechnology and functionality to a client device 102 having sufficientprocessing/memory capacity. Additionally, some functionality ofembodiments of the present disclosure may be distributed across aplurality of different processors and/or computing devices, includingone or more client devices 102 and server systems 108.

The server system 108 supports various services and operations that areprovided to the client devices 102. Such operations include transmittingdata to, receiving data from, and processing data generated by theclient device 102. This data may include, for example, message content,client device information, geolocation information, databaseinformation, transaction data, social network information, and otherinformation. Data exchanges within the system 100 are invoked andcontrolled through functions available via user interfaces (UIs) of theclient devices 102.

In the example depicted in FIG. 1, system 108 includes an ApplicationProgramming Interface (API) server 110 that is coupled to, and providesa programmatic interface to, an application server 112. The API server110 and application server 112 are communicatively coupled to a databaseserver 118, which facilitates access to a database 120 including datathat may be processed by the application server 112. In otherembodiments, the functionality of the API server 110, application server112, and database server 118 may be performed by more or fewer systems.In some embodiments, for example, server system 108 may comprise asingle server having API functionality, application functionality, anddatabase functionality.

In the example shown in FIG. 1, the API server 110 receives andtransmits data (e.g., commands and message payloads) between the clientdevice 102 and the server system 108. Specifically, the API server 110provides a set of interfaces (e.g., routines and protocols) that can becalled or queried by the one or more software applications running on aclient device 102 in order to invoke functionality of the applicationserver 112 or database server 118. The API server 110 exposes variousfunctions supported by the application server 112, including accountregistration, login functionality, the sending of messages, searchqueries, and other functionality.

The application server 112 hosts a number of applications andsubsystems. For example, the application server 112 may implement avariety of message processing technologies and functions, includingvarious data-processing operations, with respect to data received withinthe payload of a message received from one or more client devices 102,or retrieved from one or more databases 120 by database server 118.

In the example depicted in FIG. 1, system 100 may include a mapperfunctional component 150. The mapper 150 may include functionalitydescribed in more detail below, and may be implemented by server system108 and/or client devices 102. In some embodiments, the mapper 150 maybe implemented as part of an enterprise resource platform (ERP).

Software Service Platform

FIG. 2 depicts an exemplary process according to various aspects of thepresent disclosure. In this example, method 200 includes receiving arequest to perform a service (205), retrieving a configuration file(210), identifying one or more nodes, parameters, and/or customizedextensions associated with the service based on the configuration file(215), performing the service (220), and transmitting a response to theservice request (225). Method 200 further includes presenting a userinterface on display screen of a client device (230), receiving userinput via the user interface (235), generating one or more parametersbased on the user input (240), and updating the configuration file basedon the user input (235). The steps of method 200 may be performed inwhole or in part, in conjunction with each other as well as with some orall of the steps in other methods, and may be performed by any number ofdifferent systems, such as the systems described in FIGS. 1, 8, and 9.

In method 200, the system (such as server system 108 in FIG. 1) mayreceive a service request (205) from a client computing device (such asclient device 102) over a network (e.g, network 106). In alternateembodiments, the system may receive the service request (205) using avariety of different communication methods and formats. In someembodiments, the service request may be made via an API (such as aSalesforce® Connector) to invoke one or more processes.

The system retrieves a configuration file (210) containing configurationinformation for performing the service. In some embodiments, theconfiguration file may be in a markup language format (such asextensible markup language (XML)). In some embodiments, theconfiguration information may be stored in a plurality of nodes, witheach respective node in the plurality of nodes comprising a respectiveset of parameters associated with the service.

The system identifies the nodes, parameters, and customizations (such ascustomized extensions and fields) associated with the service from theconfiguration file (215). In some embodiments, the configuration filemay include nodes in a flat or hierarchal structure. In one embodiment,for example, the configuration file may include a feature nodeidentifying an application program interface (API) to be used inconjunction with performing the service. Some specific examples offeature nodes and other components of a configuration file in XML formatmay be found below in the “OPERATION EXAMPLES” section.

In some embodiments, the configuration file may include an object nodeidentifying an object component used in performing the service. Theobject node may include a variety of information, and the objectcomponent may include other nodes. For example, the object component mayinclude a query node that includes information for performing a queryfor an attribute of the object component (e.g., for information storedin database 120 in FIG. 1). The information for performing the query mayinclude information in an object query language (OQL) (such as aSalesforce® OQL) for performing the query.

The object component may include any number of different nodes. In someembodiments, for example, the object component may further include aparameter node that includes parameters for performing the query for theattribute. The object component may further include a mapping node thatincludes parameters associated with the request to perform the service,as well as an update mapping node that includes parameters associatedwith the response to the request.

The system performs the service (220) based on the content of theconfiguration file. For example, the system may perform the serviceusing a user-customized extension identified in the configuration file.In this manner, a user of the system may invoke customized hooks toperform functionality that would otherwise not be available from theAPIs of conventional systems.

The system may perform a variety of functions based on the configurationfile. In one embodiment, the configuration file comprises an identifierfor an object and validation parameters for the object. In this example,in conjunction with performing the service (220), the system validatesthe object based on the validation parameters. A specific example ofvalidating an object based on validation parameters may be found belowin the “OPERATION EXAMPLES” section with reference to addressverification.

Embodiments of the present disclosure may be utilized to validate avariety of objects based on a variety of different validationparameters. For example, the object may be or include an account, andthe validation parameters may include an account identifier and otherinformation (e.g., address information) associated with the account.

The validation parameters may include a variety of information,including nodes. Continuing the example of validating an account, thevalidation parameters may include a mapping node that includesparameters associated with a request to validate the account (e.g.,received in a service request (205)).

Similarly, the validation parameters may include an update mapping nodethat includes parameters associated with a response to the request tovalidate the account. The update mapping node parameters may be used toformat the response to the service request (225).

The system transmits a response to the request to perform the service(225). For example, the system may transmit the response to the clientcomputing device from which the service request was received (205). Theresponse may include data, status information, and other results fromperforming the service (220).

The system may present a user interface on the client device (230)(e.g., one or more windows displayed on the display screen of the clientdevice) to display or retrieve information for performing the service.In some embodiments, for example, the system may present a userinterface on the display screen of a computing device and receive (viathe user interface) user input (235) that includes OQL for performing aquery. The system may then update the configuration file (245) bystoring the OQL for performing the query within a query node in theconfiguration file. Similarly, the system may receive user input (235)that includes parameters for performing the query, and update theconfiguration file (245) to store the parameters for performing thequery within the parameter node in the configuration file.

In another example, the system may receive user input (235) via the userinterface that includes an identifier for customized extension, andupdate the configuration file (245) by storing the customized extensionidentifier in the configuration file. Similarly, the system may presenta user interface (230) on a display screen of the client computingdevice that includes an identifier for a hook associated with theservice. The system may receive user input (235) via the user interfacethat includes a definition for the customized extension, and update theconfiguration file (245) by storing the definition for the customizedextension in the configuration file. In this manner, a user may createcustom processes and identify them via the configuration file to beexecuted during performance of the service. For example, the system mayperform the service by executing a first process associated with theservice, and executing a second process associated with the customizedextension. Any number of such built-in and customized processes may beexecuted in conjunction with the performance of a service by embodimentsof the present disclosure.

The system may present a variety of user interface screens (230) toreceive content for updating the configuration file (245). Specificexamples of user interface screens that may be used in conjunction withembodiments of the present disclosure are depicted in FIGS. 7D-7S anddescribed below in the “OPERATION EXAMPLES” section with reference tothe Tax Mapper example and the Mapper Studio.

The system may also generate content for the configuration based oninput received from the user. For example, the system may receiving userinput via the user interface that includes an identifier for the object,and generate parameters (240) for the object (e.g., validationparameters as described above) based on the object identifier. Thesystem may update the configuration file (245) by storing the objectidentifier and the validation parameters for the object in theconfiguration file.

FIG. 3 is a functional block diagram of a software architectureillustrating the operation of a mapper in conjunction with othercomponents according to various embodiments of the present disclosure.In this example, the system performs tax calculations and othertax-related services (e.g., as described in more detail below in the“OPERATION EXAMPLES” section. The functionality of the system in FIG. 3may be performed by any number of different systems, such as the systemsdescribed in FIGS. 1, 8, and 9.

In this example, customers 310 (e.g., customers 311, 312, 313, . . . )interface with ERP systems 321, 322 (e.g., via respective clientcomputing devices associated with each respective customer). Database323 stores customer data associated with customer 311. Tax informationis received from one or more tax jurisdictions 330 (e.g. 331, 332, 333,. . . ).

Component 390 represents an embodiment of a mapper according to variousaspects of the present disclosure (e.g., a tax mapper as describedbelow). The mapper 390 may communicate with an online tax-assistingservice 340 via connector 371 to API 379.

The tax-assisting service 340 includes a tax content managementcomponent 344 with a database 346 to store tax rules, rates, exemptions,etc. The tax-assisting service 340 may be invoked via API 379, forexample when it receives a request with data 376 on behalf of customer311 from EPR 321. Data 376 may be looked up from customer data indatabase 323.

In this example, tax-assisting engines 342 includes an addressvalidation engine 352 and a tax computation engine 354. Upon beinginvoked, address validation engine 352 performs an address-validationprocess based on the customer data 376 and responds with addressfeedback response 377 (e.g., a validated address or an indication anaddress is invalid). The tax computation engine 365 responds to aninvocation by calculating tax liability 379, the amount of tax due.

In some embodiments, the tax-assisting service 340 may perform a varietyof services related, or in addition to, the address validation andtax-computation services described above. For example, the tax-assistingservice 340 may accumulate and store sales data 376. In another example,another engine or functional component (not shown), upon being invoked,can register one or more of customers 310 with one or more appropriatetax jurisdictions 330. In yet another example, another engine orfunctional component (not shown), upon being invoked, can generate taxreturns (e.g., filled forms) for customers 310 and/or file such returnswith the appropriate tax jurisdiction(s) 330.

FIG. 4A illustrates a functional block diagram of a conventional ERPsystem 321. In this example, ERP system 321 includes applications 141,142, 143 to provide the services of the ERP. In one particular example,ERP 321 may be hosted by a Salesforce® host and include a billingapplication 441 (“Billing”), a Configure Price Quote (CPQ) application442, and a web services application 443 (“salesforce.com”).

In this example, customer 311 has connectors 411, 412, 413 that caninvoke applications 441, 442, 443, respectively. Each of 441, 442, 443communicates with platform 450 which, in turn, communicates withdatabase 323 storing customer data. If access to the tax-assistingservice 340 has been enabled, applications 441, 442, 443 can actuatetheir respective connector 471, 472, 473 to operate as connector 371 inFIG. 3. In some embodiments, connectors 471, 472, 473 can also activateplatform 450, and get a response.

FIG. 4B illustrates a functional block diagram providing additionaldetail for the ERP system 321 shown in FIG. 4A. In this example (forease of illustration), only one application 441 is shown, with itsconnector 471 and application 441. In this example, the ERP 121 permitsfield customization 429. However, such customization presents a problemfor connector 471, because it is unable to properly call API 379 withthe added customization. As such, customer 311 may be unable to fullycustomize the functionality of ERP 321 to suit customer 311's needs.

FIG. 5 illustrates a functional block diagram of an ERP 321 thatincludes a mapper component 590 to address the service-customizationissues with the conventional ERP systems shown in FIGS. 4A and 4B. Inthe example depicted in FIG. 5, mapper 390 envelops connectors 471, 472,473.

Additionally, configuration files 581, 582, 583 are generated forrespective connectors 471, 472, 473. These configuration files 581, 582,583 are also enveloped by mapper 590 in this example. In someembodiments, the configuration files may comprise a markup languageformat that is both machine-readable and human-readable. For example, asdescribed in other examples herein, the configuration files 581, 582,583 may be extensible markup language (XML) files.

In this example, mapper 590 interfaces with applications 441, 442, 443.Mapper 590 also interfaces with platform 450 and API 379. In thisexample, a mapper UI suite 595 may be used to present user interfacescreens (e.g., such as the UI screens depicted in FIGS. 7D-7S describedbelow) to display and collect information from customers 311 to generateor modify configuration files 581, 582, 583. As described herein, mapper590 may utilize configuration files 581, 582, 583 in conjunction withcustomer data 599 to perform custom processes related to applications441, 442, 443.

FIG. 6 provides a more detailed functional block view of the ERP 321 inFIG. 5. In this example, an XML analyzer component 651 retrieves andanalyzes one or more configuration files 581, 582, 583 and identifiescustomized fields and extensions 429 defined in the configurationfile(s). The customizations are used by tax computation planner 452,454. User-customizations to hooks in the configuration files 581, 582,583 identified by the XML analyzer 651 may be used via the hook manager692.

Operation Examples

Embodiments of software service platforms of the present disclosure maybe used in a variety of applications. One example of such animplementation is described below for performing address validation andtax calculation. This embodiment may be referred to as “AvaTax Mapper,”“Tax Mapper,” or “AvaTax” herein.

Conventional software service platforms often cannot reliably provideaccurate tax information in all instances for a variety of reasons.Inaccurate tax information may result in a business overpaying in tax,which is plainly not good business, or in underpaying, for example ifwhole classes of tax due are missed, such as taxes owed tomunicipalities.

Businesses are required by law to be tax compliant. To begin with, taxcompliance means knowing how much money a business owes in taxes and towhich tax authority, and paying it. Not knowing about a tax is not anexcuse; if a business fails to accurately report and pay taxes it owes,it may be subject to audits and fines.

Accurate knowing of one's tax liability is rarely easy. Tax may be owedto various tax jurisdictions, such as cities, states, municipalities,and so on, all of each can have different tax rates. There are over10,000 tax jurisdictions in the US, each with its own rules. In all,there are almost 10 million taxability rules related to various productsand services in the US. And, for a single transaction, there may be morethan one tax jurisdiction that money is owed to.

Makers of goods may be subject to excise taxes, and excise taxes maythus impact the supply chain. Plus, when businesses make, sell, and/orbuy goods, more taxes and requirements may come due. Such taxes includesales tax, use tax, value-added tax, and so on, possibly to multiplejurisdictions from a single sale. For each sale, the seller mustdetermine whether, and when, it must collect sales tax in each taxjurisdiction. For each state, a seller may need to register with thatstate's taxing agency, set up internal processes for collecting salestax in accordance with the tax rules and the timetables of the state,keep records for the collected sales tax, file reports with the state,and finally pay the tax to the state.

Each jurisdiction has its own rules about sales tax for those who sellitems. In addition, the rules for determining the sales tax due mayarise from the location of the buyer and the seller, or that of adistributor, etc. For instance, some state and local authorities haveorigin-based rules, which means that a sales tax is charged from theseller's location, while other state and local authorities havedestination-based rules, which means that a sales tax is charged fromthe buyer's location. In each instance the seller must collect, report,and pay the correct amount for each locality.

Some jurisdictions exempt the sale of some items from sales tax, butthat requires detailed research. For instance, deodorant may be taxablein 2018 in one state, but antiperspirant may be tax exempt. At the sametime, a particular type of product may be exempt from sales tax in onestate, but not in another state.

Tax compliance even includes requirements for some situations wheresales tax is not due. For instance, when a seller buys certain items forresale, the items may be exempt from sales tax, as long as the sellercreates and maintains proper certificates.

AvaTax® Mapper helps address these and other issues by providing is aframework that helps users create Address Validation and Tax Calculationrequests based upon an XML configuration file. It includes a largelibrary for Analyzing the XML file and formulating the service requestmodels. It supports a variety of Salesforce-based products like CPQ andBilling.

In one exemplary embodiment, The architecture of the Tax Mapper includesthe following components as shown in FIG. 7A: an XML Analyzer, a TaxCalculator, an Address Validator, and a Hook Manager.

In this example, the XML analyzer provides a platform for reading XMLconfiguration file, which extracts a meaningful data and converts itinto a map/dictionary of an understandable data type. Thismap/dictionary plays an important role while creating service requestobjects required by AvaTax® services.

The Tax Calculator class handles all the complexities of creating taxcalculation request from an XML file. It also provides out of the boxHooks, which can be extended by the customers to override the defaultflow of the AvaTax® Mapper. So that it can fit into their businessprocess if required. The following extension methods are provided fortax calculation: Before Tax Calculation; Tax Validation; OverrideRequest Line; Before Update; and After Update.

The Address Validator class handles all the complexities of creatingaddress validation request and displaying the validated address on theseparate page. It also provides an option to update the original addressif the user wants to update the address.

The hook manager is the core of providing extension, so that thecustomer/SI partners can modify the web request that is going to theAvaTax® engine. The administrator or developer needs to create a class,which implements a particular interface for accomplishing certainmodification in the system to handle custom business requirement. Thenthe user can provide the class name in XML config file. The hook managertakes into consideration about the extensions that have been provided inXML config.

To elaborate more about the provided hook manager and extensions,consider the sequence diagram in FIG. 7B. In this example, the solidarrows illustrate actions taken by the Tax Calculator class, whereas thedotted arrows represent the hooks that can be customized by a user(e.g., an administrator or developer):

The AVATAX® Mapper XML configuration file helps to specify “RequestResponse” parameter for consuming AvaTax® service. The Mapper XML ispart of the Base AvaTax® package. The XML formulate the request andupgrade the response for Tax Calculation, Address Validation, andDocument Commits. This topic describes the main configuration settingsthat you can make in the AVATAX® XML.config file.

Configuration File Section

The XML configuration file is divided in various node that are specifiedas:

XML Scaffold <avatax> <FeatureNode1> <ObjectNode1>  <ObjectComponent1><Hook></Hook> <QueryNode></QueryNode> <ParameterNode> </ParameterNode><MappingNode></MappingNode> <UpdateMappingNode> </UpdateMappingNode> </ObjectComponent1> </ObjectNode1> . . .  <ObjectNode n> </ObjectNoden> </FeatureNode1> . . . <FeatureNode n></FeatureNode n> </avatax>

Beginning Node

This node specifies the beginning of the AVATAX XML Mapper file. Forexample, <avatax></avatax>.

Feature Node

This node specifies the beginning of the function name that needs to becovered under the XML. Based on the value and purpose, the AVATAX®Salesforce® Core package decides, which AVATAX® API need to call. Forexample, <addressvalidation></addressvalidation>.

Object Node

This node specifies a Salesforce® Object for Feature Node. For example,<Account></Account>.

Object Component

This node specifies the Object Component that needs to be considered forthe Feature node. For example, Billing Address From Account to beconsidered for Address Validation.

The account contains two Addresses “Billing and Shipping.” In thisexample, you are considering Billing Address. For example, FeatureNode=Address Validation; Object Node=Account; and ObjectComponent=Billing.

The object component contains the following nodes: a Query Node; aParameter Node; a Mapping Node, and an Update Mapping Node.

The Query Node specifies the object query language (OQL) (e.g.,Salesforce® OQL) that need to query for fetching the attribute of theObject Component specified in the Object Component Node. This nodespecifies the attribute that needs to be queried and can be furtherspecified for the Mapping Node.

<query> select BillingStreet,BillingCity,BillingState,BillingCountry,Billingpostalcode fromAccount where id =‘{AccountId}’ </query>

The Parameter Node specifies the attribute that needs to be used for theWHERE clause in SOQL specified in Query Node.

<query> select BillingStreet,BillingCity,BillingState,BillingCountry,Billingpostalcode from Accountwhere id = ‘{AccountId}’ </query> <parameters> <AccountId>Id</AccountId> </parameters>

Note: The id—<AccountId<Id</AccountId> here is the record id of theobject.

The Mapping node specifies the Request parameters required for Requestcreation for Feature Node. Each parameter in the node is a FeatureRequest Parameter.

<Mapping> <line1>BillingStreet</line1> <city>BillingCity</city> <region>BillingState </region> <country>BillingCountry</country> <postalcode>Billingpostalcode </postalcode> </Mapping>

The Update Mapping Node specifies the Response field, where ServiceResponse needs to be shown. For example, Address Validation Feature.

<UpdateMapping> <line1>BillingStreet</line1> <city>BillingCity</city><region> BillingState </region> <country>BillingCountry</country><postalcode> Billingpostalcode </postalcode> </UpdateMapping>

Sample Tax Calculation XML

The XML hierarchy remains the same till the Object Node, and the changefrom Object Component Node are:

Let's now consider Tax Calculation XML

Header Node

This node is used for specifying the Header of the Tax Calculationrequest.

The header node contains the following nodes below:

Query Node

This node specifies the SOQL that need to query for fetching theattribute of the Object Component specified in the Object ComponentNode. Also, specifies the attribute to be queried and can be furtherspecified for the Mapping Node.

<query> select Id, AccountId,SalesTax_(——)c,CloseDate,LeadSource fromOpportunity where id = ‘{OpportunityId}’ </query>

Parameter Node

This node specifies the attribute to be used for the WHERE clause inSOQL specified in Query Node.

<query> select Id, AccountId,SalesTax_(——)c,CloseDate,LeadSource fromOpportunity where id = ‘{OpportunityId}’ </query> <parameters><OpportunityId>Id</OpportunityId> </parameters>

Note: The id—<OpportunityId>Id</OpportunityId>here is the record id ofthe object.

Mapping Node

This node specifies the Request parameters essential for Requestcreation for Feature Node. Also, each parameter in the node is a FeatureRequest Parameter.

<Mapping> <code>Id</code> <customerCode>AccountId</customerCode><description>LeadSource</description> </Mapping>

Update Mapping Node

This node specifies the Response field, and where Service Response needsto be shown. For example, Address Validation Feature.

<UpdateMapping> < SalesTax_(——)c >totalTax</line1> </UpdateMapping>

Line Node

This node is used for specifying the Line of the Tax Calculationrequest.

The line node contains the below nodes:

Query Node

This node specifies the SOQL that need to be queried for fetching theattribute of the Object Component specified in the Object ComponentNode.

This node specifies attribute to be queried and can be further specifiedfor the Mapping Node.

<query> select Id, Pricebookentry.product2.ProductCode, Description,SalesTax_(——)c, Quantity, TotalPrice, UnitPrice from OpportunityLineItemwhere OpportunityId = ‘{OpportunityId}’ </query>

Parameter Node

This node specifies the attribute to be use for the WHERE clause in SOQLspecified in Query Node.

<query> select Id, Pricebookentry.product2.ProductCode, Description,SalesTax_(——)c, Quantity, TotalPrice, UnitPrice from OpportunityLineItemwhere OpportunityId = ‘{OpportunityId}’ </query> <parameters><OpportunityLineId>Id</ OpportunityLineId > </parameters>

Note: The id—<OpportunityLineId>Id</OpportunityLineId> here is therecord id of the object.

Mapping Node

This node specifies the Request parameters essential for Requestcreation for Feature Node.

Each parameter in the node is a Feature Request Parameter.

<Mapping> <quantity> Quantity </code> <itemCode>Pricebookentry.product2.ProductCode </customerCode> <amount> TotalPrice</description> </Mapping>

Update Mapping Node

This node specifies the Response field, and where Service Response needsto be shown. For example, Address Validation Feature.

<UpdateMapping> <SalesTax_(——)c >totalTax</line1> </UpdateMapping>

How to Use AvaTax Mapper:

Address Validation

Address Validation follows easy and convenient approach using AvaTaxMapper.

Consider you need to have Address Validation on Account Object, and thenyou need to follow these steps:

Steps

As depicted in FIG. 7F, create a Button on the Object where TaxCalculation needs to be done. Select the Content Source as URL for thebutton. In URL box enter the data:/apex/addressValidation?id={!Account.Id}&sType=CPQ

In the example depicted in FIG. 7F, {!Account.id} specifies the Objectid for Object where Address Validation need to be done.

AvaTax XML

<addressvalidation>  <Account> <Billing>  <query>select BillingStreet,BillingCity,BillingState,BillingCountry,Billingpostalcode from Accountwhere id = ‘{AccountId}’</query> <parameters>  <AccountId>Id</AccountId></parameters>  <Mapping> <line1>BillingStreet</line1><city>BillingCity</city> <region>BillingState</region><country>BillingCountry</country><postalcode>Billingpostalcode</postalcode>  </Mapping>  <UpdateMapping><line1>BillingStreet</line1> <city>BillingCity</city><region>BillingState</region> <country>BillingCountry</country><postalcode>Billingpostalcode</postalcode>  </UpdateMapping> </Billing></Account> </addressvalidation>

Common Configuration

global class Configuration extends ConfigurationBase{  publicConfiguration( )  { environment = AvaTaxEnvironment.Sandbox; companyCode= ‘AvaTax Company Code’; username = ‘AvaTax Username’; password =‘AvaTax Password’; isTaxCalculationEnabled = true;  } }

Tax Calculation

Tax Calculation is easy and convenient using AvaTax Mapper.

Steps

Create a Visualforce page and add the Apex class as Controller Extensionas shown

One must create a Configuration file for Config fetching, and the usageis depicted in Class TaxCalculator.

Visualforce Page

<apex:page standardController=″Account″ extensions=″ TaxCalculator″action=” taxCalculator”> </apex:page>

Apex Class

Public class TaxCalculator { Public void taxCalculator( ) {Configuration cm = new Configuration( ); ConfigurationBase config =cm.getConfig( ); Map<String, String> oppParam = new Map<String,String>();  TaxCalculationInput taxCalcInput = new TaxCalculationInput( );taxCalcInput.recordId = opp.id; taxCalcInput.controller =opp.id.getSObjectType( ).getDescribe( ).getName( ).toLowerCase( );taxCalcInput.optionalParams = oppParam;taxCalc.calculateTax(taxCalcInput);  } }

Create a button on an Object and the Content Source for thebutton>Visualforce Page

Add the Visualforce Page create in step 2 and create the button.

For the scope of this example, a field “SalesTax_c” has been created onOpportunity and Opportunity product to show the response from the taxservice.

Sample XML

<Opportunity>  <query>select Id,AccountId,SalesTax_(——)c,CloseDate,LeadSource  from Opportunity where id= ‘{OpportunityId}’</query>  <parameters><OpportunityId>Id</OpportunityId>  </parameters>  <Mapping><code>Id</code> <customerCode>AccountId</customerCode><description>LeadSource</description>  </Mapping>  <UpdateMapping><SalesTax_(——)c>totalTax</SalesTax_(——)c>  </UpdateMapping></Opportunity>

AvaTax XML

<taxcalculation>  <Opportunity>  <hooks><overriderequestline></overriderequestline><beforetaxcalculation></beforetaxcalculation><beforeupdate></beforeupdate> <afterupdate></afterupdate>  </hooks> <Header> <Queries>  <Opportunity> <query>select Id,AccountId,SalesTax_(——)c,CloseDate,LeadSource from Opportunity where id= ‘{OpportunityId}’</query> <parameters> <OpportunityId>Id</OpportunityId> </parameters> <Mapping> <code>Id</code>  <customerCode>AccountId</customerCode> <description>LeadSource</description> </Mapping> <UpdateMapping> <SalesTax_(——)c>totalTax</SalesTax_(——)c> </UpdateMapping> </Opportunity>  <Account> <query>select Id, AccountNumber, Name,ShippingStreet, ShippingCity, ShippingState, Shippingpostalcode,ShippingCountry,  BillingStreet, BillingCity, BillingState,Billingpostalcode, BillingCountry from Account where Id =‘{AccountId}’</query> <parameters> <AccountId>Opportunity.AccountId</AccountId> </parameters> <Mapping> <exemptNo>AccountNumber</exemptNo> <addresses.shipTo.line1>ShippingStreet</addresses.shipTo.line1> <addresses.shipTo.line2 />  <addresses.shipTo.line3 /> <addresses.shipTo.city>ShippingCity</addresses.shipTo.city> <addresses.shipTo.region>ShippingState</addresses.shipTo.region> <addresses.shipTo.country>ShippingCountry</addresses.shipTo.country><addresses.shipTo.postalcode>Shippingpostalcode</addresses.shipTo.postalcode> <addresses.shipTo.latitude></addresses.shipTo.latitude> <addresses.shipTo.longitude></addresses.shipTo.longitude> <addresses.shipFrom.line1>BillingStreet</addresses.shipFrom.line1> <addresses.shipFrom.line2 />  <addresses.shipFrom.line3 /> <addresses.shipFrom.city>BillingCity</addresses.shipFrom.city> <addresses.shipFrom.region>BillingState</addresses.shipFrom.region><addresses.shipFrom.country>BillingCountry</addresses.shipFrom.country> <addresses.shipFrom.postalcode>Billingpostalcode</addresses.shipFrom.postalcode> <addresses.shipFrom.latitude></addresses.shipFrom.latitude> <addresses.shipFrom.longitude></addresses.shipFrom.longitude></Mapping> <UpdateMapping>  <SalesTax_(——)c>totalTax</SalesTax_(——)c></UpdateMapping>  </Account> </Queries>  </Header>  <Line> <Queries> <OpportunityLineItem> <query>select Id,Pricebookentry.product2.ProductCode, Description, SalesTax_(——)c, Quantity, TotalPrice, UnitPrice from OpportunityLineItem whereOpportunity Id = ‘{OpportunityId}’</query> <parameters> <OpportunityId>Opportunity.Id</OpportunityId> </parameters> <Mapping> <description>Description</description>  <quantity>Quantity</quantity> <itemCode>Pricebookentry.product2.ProductCode</itemCode> <amount>TotalPrice</amount> </Mapping> <UpdateMapping> <SalesTax_(——)c>tax</SalesTax_(——)c> </UpdateMapping> </OpportunityLineItem> </Queries>  </Line>  </Opportunity></taxcalculation>

Post-Tax Calculation

Post-Tax Calculation is easy and convenient using AvaTax Mapper.

Steps

Create a Visualforce page and add the Apex class as Controller Extensionas shown

One must create a Configuration file for Config fetching, and the usageis depicted in Class TaxCalculator.

Visualforce Page

<apex:page standardController=″Account″ extensions=″ PostTaxCalculator″action=” taxCalculator”> </apex:page>

Apex Class

Public class PostTaxCalculator { Public void taxCalculator( ) {Configuration cm = new Configuration( ); ConfigurationBase config =cm.getConfig( ); Map<String,String> oppParam = new Map<String,String>(); PostTaxCalculator ptc = new PostTaxCalculator(‘CPQ’,config);PostTaxCalculationInput postTaxCalcinput = new PostTaxCalculationInput(); postTaxCalcInput.companyCode = ‘DEFAULT’;postTaxCalcInput.transactionCode = String.valueof(opp.id);postTaxCalcInput.commitFlag = true; postTaxCalcInput.docType =DocumentType.SalesInvoice; ptc.postTax(postTaxCalcInput);  } }

Create a button on an Object and the Content Source for thebutton>Visualforce Page

Add the Visualforce Page create in step 2 and create the button.

AvaTax XML

<posttaxcalculation>  <Opportunity> <hooks> </hooks> <Queries> <Opportunity> <query>select Id,AccountId,SalesTax_(——)c,CloseDate,LeadSource from Opportunity where id= ‘{OpportunityId}’</query> <parameters> <OpportunityId>Id</OpportunityId> </parameters> <Mapping> <transactionCode>Id </transactionCode>  </Mapping>  </Queries> </Opportunity>  </posttaxcalculation>

Cancel Tax Calculation

Cancel Tax Calculation is easy and convenient using AvaTax Mapper.

Steps

Create a Visualforce page and add the Apex class as Controller Extensionas shown

One must create a Configuration file for Config fetching, and the usageis depicted in Class TaxCalculator.

Visualforce Page

<apex:page standardController=″Account″ extensions=″aCancelTaxCalculator″ ction=” taxCalculator”> </apex:page>

Apex Class

Public class CancelTaxCalculator { Public void taxCalculator( ) {Configuration cm = new Configuration( ); ConfigurationBase config =cm.getConfig( ); Map<String,String> oppParam = new Map<String,String>(); CancelTaxCalculationInput cancelTaxCalcInput = newCancelTaxCalculationInput( ); cancelTaxCalcInput.recordId = opp.id;cancelTaxCalcInput.controller = opp.id.getSObjectType( ).getDescribe().getName( ).toLowerCase( ); cancelTaxCalcInput.optionalParams =oppParam; cancelTaxCalcInput.companyCode = ‘DEFAULT’;cancelTaxCalcInput.transactionCode = String.valueof(opp.id);cancelTaxCalcInput.code = VoidReasonCode.DocVoided;cancelTaxCalcInput.docType = DocumentType.SalesInvoice;ctc.cancelTax(cancelTaxCalcInput);  } }

Create a button on an Object and the Content Source for thebutton>Visualforce Page

Add the Visualforce Page create in step 2 and create the button.

Apex Class

<canceltaxcalculation>  <Opportunity> <hooks> </hooks> <Queries> <Opportunity> <query>select Id,AccountId,SalesTax_(——)c,CloseDate,LeadSource from Opportunity where id= ‘{OpportunityId}’</query> <parameters> <OpportunityId>Id</OpportunityId> </parameters> <Mapping><transactionCode>Id </transactionCode>  </Mapping>  </Queries> </Opportunity> </canceltaxcalculation>

Hooks Manager

This manager is the core of providing extension so that customer/SIpartners can modify the web request that is going to AvaTax engine.

Hook manager takes into consideration about the extensions that havebeen provided in XML config.

Hooks available for tax calculation are below:

AvaTax XML

<taxcalculation>  <Order> <hooks> <overriderequestline></overriderequestline> <beforetaxcalculation></beforetaxcalculation> <beforeupdate></beforeupdate>  <afterupdate></afterupdate> </hooks></Order> </taxCalculation>

Example for Hooks Definition

BeforeTaxCalculationExtender:

global class BeforeTaxCalculationExtender implementsIBeforeTaxCalculation {  global voidhookExtention(CreateTransactionModel model, Map<String,List<SObject>>headerResults) { model.code = ‘overrideDocCode’;  } }

Now to provide the extension in XML file you need to update XML asfollows:

<taxcalculation>  <Order> <hooks> <overriderequestline></overriderequestline> <beforetaxcalculation>BeforeTaxCalculationExtender </beforetaxcalculation>  <beforeupdate></beforeupdate> <afterupdate></afterupdate> </hooks> </Order> </taxCalculation>

AvaTaxClient

Description Initializes Rest client with supplied parameters. Returns Anew object of AvaTaxClient class. Parameters AppName Name of callingapplication. Mostly it is ERP/Salesforce Package Name which is willingto call AvaTax Services. AppVersion A version of the callingapplication. MachineName Name of the machine from which this call isbeing made. In case of Salesforce, it can be the hostname. EnvironmentSelect whether calls to be made to AvaTax Sandbox or Productionenvironment.

Methods

WithSecurity

Description Initializes AvaTaxClient class with security information.Note if you want to send username and password for authentication thenuse this method. Returns An instance of the AvaTaxClient class.Parameters Username Username provided by Avalara. Password Passwordprovided by Avalara.

WithSecurity

Description Initializes AvaTaxClient class with security information.Note if you want to send Account Id and License Key for authenticationthen use this method. Returns An instance of the AvaTaxClient class.Parameters AccountId 10-digit Account Id provided by Avalara. LicenseKey16-character License Key provided by Avalara.

resolveAddressPost

Description Retrieve geolocation information for a specified address. Ifthe address can be resolved, then this API provides the latitude andlongitude of the resolved location. The value ‘resolutionQuality’ can beused to identify how closely this address can be located. If the addresscannot be located, then use the ‘messages' structure to learn more aboutproblems with this address. Returns Parameters Model Instance ofAddressValidationInfo.

CreateTransaction

Description Records a new transaction in AvaTax. A transactionrepresents a unique potentially taxable action that your company hasrecorded, and transactions include actions like sales, purchases,inventory transfer, and returns (also called refunds). ReturnsTransactionModel as transaction object. Parameters Model Instance ofCreateTransactionModel. Include Specifies objects to include in theresponse after transaction is created Lines Details (implies lines)Summary (implies details) Addresses SummaryOnly (omit lines anddetails - reduces API response size) LinesOnly (omit details - reducesAPI response size) ForceTimeout - Simulates a timeout. This adds a 30second delay and error to your API call. This can be used to test yourcode to ensure it can respond correctly in the case of a droppedconnection.

CommitTransaction

Description Marks a transaction by changing its status to Committed.Transactions that are committed are available to be reported to a taxauthority by Avalara Managed Returns. A transaction represents a uniquepotentially taxable action that your company has recorded, andtransactions include actions like sales, purchases, inventory transfer,and returns (also called refunds). If you have more than one documentwith the same code, specify the documentType parameter to choose betweenthem. Any changes made to a committed transaction will generate atransaction history. Returns TransactionModel as transaction object.Parameters CompanyCode The company code of the company that recordedthis transaction. TransactionCode The transaction code to commit. ModelInstance of CommitTransactionModel. Document Type (Optional): Thedocument type of the transaction to void. If not provided, the defaultis SalesInvoice.

VoidTransaction

Description Voids the current transaction uniquely identified by thisURL. A transaction represents a unique potentially taxable action thatyour company has recorded, and transactions include actions like sales,purchases, inventory transfer, and returns (also called refunds). Whenyou void a transaction, that transaction's status is recorded asDocVoided. If you have more than one document with the same code,specify the documentType parameter to choose between them. Transactionsthat have been previously reported to a tax authority by Avalara ManagedReturns are no longer available to be voided. Returns TransactionModelas transaction object. Parameters CompanyCode The company code of thecompany that recorded this transaction. TransactionCode The transactioncode to commit. Model Instance of VoidTransactionModel. Document Type(Optional): The document type of the transaction to void. If notprovided, the default is SalesInvoice.

Models

AddressResolutionModel

Description Validated Address Resolution.

Properties

The following are the address resolution model properties and theirinformation:

Properties Description Data Type Address The original address.AddressInfo Coordinates The geospatial coordinates CoordinateInfo ofthis address. Messages List of informational and AvaTaxMessage warningmessages regarding this address. resolutionQuality The resolutionquality of the resolutionQuality geospatial coordinates = [‘NotCoded’,‘External’, ‘CountryCentroid’, ‘RegionCentroid’, ‘PartialCentroid’,‘PostalCentroidGood’, ‘PostalCentroidBetter’, ‘PostalCentroidBest’,‘Intersection’, ‘Interpolated’, ‘Rooftop’, ‘Constant’]. taxAuthoritiesList of tax authorities TaxAuthorityInfo associated with this address.validatedAddresses The validated address or ValidatedAddressInfoaddresses.

ValidatedAddressInfo

Description The validated address.

Properties

The following are the validate address info model properties and theirinformation:

Properties Description Data Type addressType Firm or company addressString General Delivery address High-rise or business complex PO Boxaddress Rural route address city City component of the String address.country Name or ISO 3166 code String identifying the country. latitudeGeospatial latitude Double measurement, in Decimal Degrees, floatingpoint format. line1 The first line of the street String address. line2The second line of the street String address. line3 The third line ofthe street String address. longitude Geospatial longitude Doublemeasurement, in Decimal Degrees, floating point format. postalCodePostal Code/Zip Code String component of the address. region Name or ISO3166 code String identifying the region within the country.

AddressInfo

Description Represents Address for validation or tax calculation.

Properties

The following are the address info properties and their information:

Properties Description Data Type city City component of the Stringaddress. country Name or ISO 3166 code String identifying the country.latitude Geospatial latitude Double measurement, in Decimal Degrees,floating point format. line1 The first line of the street Stringaddress. line2 The second line of the street String address. line3 Thethird line of the street String address. longitude Geospatial longitudeDouble measurement, in Decimal Degrees, floating point format.postalCode Postal Code/Zip Code String component of the address. regionName or ISO 3166 code String identifying the region within the country.

CoordinateInfo

Description Validated Address Resolution.

Properties

The following are the coordinate info properties and their information:

Properties Description Data Type latitude Latitude Double longitudeLongitude Double

AvaTaxMessage

Description Informational and warning messages regarding the object.

Properties

The following are the AvaTax message properties and their information:

Properties Description Data Type details Detailed information thatString explains what the summary provided. refersTo Information aboutwhat String object in your request this message refers to. severity Acategory that indicates String how severely this message affects theresults. source The name of the code or String service that generatedthis message. summary A summary of what this String message tells us.

TaxAuthorityInfo

Description informational and warning messages regarding the address.

Properties

The following are the tax authority info properties and theirinformation:

Properties Description Data Type avalaraId A unique ID number Stringassigned by Avalara to this tax authority. jurisdictionName The friendlyjurisdiction String name for this tax authority. jurisdictionType Thetype of jurisdiction JurisdictionType referenced by this tax authority.[‘Country’, ‘State’, ‘County’, ‘City’, ‘Special’]. signatureCode AnAvalara-assigned String signature code for this tax authority.

TransactionModel

Description Transaction Model.

Properties

The following are the transaction model properties and theirinformation:

Properties Description Data Type addresses A list of line items in thisTransactionAddressModel transaction. adjustmentDescription If thistransaction has String been reported to a tax authority, then thistransaction is considered locked and may not be adjusted afterreporting. adjustmentReason If this transaction was AdjustmentReasonadjusted, then it indicates the unique ID number of the reason why thetransaction was adjusted. batchCode If this transaction was Stringcreated as part of a batch, then this code indicates which batch.businessIdentificationNo VAT business String identification number usedfor this transaction. code A unique customer- String provided code isidentifying this transaction. companyId The unique ID number of Long thecompany that recorded this transaction. country If this transaction wasString adjusted, this indicates the version number of this transaction.Incremented each time the transaction is adjusted.

Properties Description Data Type currencyCode The three-character StringISO 4217 currency code that was used for payment for this transaction.customerUsageType The customer usage String type for this transaction.Customer usage types often affect exemption or taxability rules.customerVendorCode Customer Vendor String Code. description Descriptionof this String transaction. Field permits unicode values.destinationAddressId The unique ID number Long of the destinationaddress for this transaction. email The email address String associatedwith this transaction. exchangeRate If this transaction Decimal includedforeign currency exchange, this is the exchange rate that was used.exchangeRateEffectiveDate If this transaction DateTime included foreigncurrency exchange, this is the date as of which the exchange exemptNorate was calculated. String If this transaction were exempt, this fieldwould contain the word “Exempt.” history If this transaction hasTransactionModel been adjusted, this list contains all the previousversions of the document. id The unique ID number Long of thistransaction. isSellerImporterOfRecord If true, this seller was Booleanconsidered the importer of record of a product shipped internationally.lines A list of line items in TransactionLineModel this transaction.

Properties Description Data Type locationCode (DEPRECATED) This Stringfield has been replaced by the reportingLocationCode field. To ensureconsistency of field names; Please use reportingLocationCode instead.locationTypes A list of location TransactionLocationTypeModel types inthis transaction. locked The two or three- Boolean character ISO regioncode of the region for this transaction. messages List of informationalAvaTaxMessage and warning messages regarding this API call. Thesemessages are only relevant to the current API call. modifiedDate Thedate/time when DateTime this record was last modified. modifiedUserIdThe user ID of the Long user who last modified this record.originAddressId The unique ID number Long of the origin address for thistransaction. parameters Contains a list of extra String parameters thatwere set when the transaction was created. paymentDate The date whenDateTime payment was made on this transaction. By default, this shouldbe the same as the date of the transaction. purchaseOrderNo Thecustomer- String supplied purchase order number for this transaction.reconciled If this transaction has Boolean been reconciled against thecompany's ledger, this value is set to true. referenceCode Auser-defined String reference code for this transaction. region Thetwo-character String ISO 3166 code of the country for this transaction.reportingLocationCode If this transaction was String made from aspecific reporting location, this is the code string of the location.salespersonCode The salesperson who String provided this transaction.Not required. softwareVersion The software version String used tocalculate this transaction. status It shows the status of DocumentStatusthe transaction. summary It shows the tax TransactionSummary summary ofthe taxDate transaction. DateTime Tax date for this transaction.taxOverrideAmount If a tax override was Decimal applied to thistransaction, then it indicates the amount of tax that was requested bythe customer. taxOverrideReason If a tax override was String applied tothis transaction, indicates the reason for the tax override.taxOverrideType The total amount of TaxOverrideTypeId this transaction.totalAmount The total amount of Deecimal this transaction. totalExemptThe amount of this Deecimal transaction that was exempt. total Tax Thetotal tax Deecimal calculated for all lines in this transaction.totalTaxable The portion of the total Decimal amount of this transactionthat was taxable. totalTaxCalculated If a tax override was Decimalapplied to this transaction, indicates the amount of tax Avalaracalculated for the transaction. transactionDate The date on which thisDateTime transaction occurred. type The type of the DocumentTypetransaction. For Returns customers, a transaction type of “Invoice” willbe reported to the tax authorities. version The software version Longused to calculate this transaction.

TransactionLocationTypeModel

Description Transaction Location Type Model.

Properties

The following are the transaction location type model properties andtheir information:

Properties Description Data Type documentAddressId Address ID for theLong transaction. documentId Transaction ID. Long documentLocationTypeIdLocation type ID for this Long location type in transaction.locationTypeCode Location type code. String

TransactionSummary

Description Transaction Summary.

Properties

The following are the transaction summary properties and theirinformation:

Properties Description Data Type country Two-character ISO-3166 Stringcountry code. exemption The amount of the transaction Decimal that wasexempt. jurisCode Jurisdiction Code for the String taxing jurisdiction.jurisName The name of the jurisdiction String that collects this tax.jurisType The type of jurisdiction that JurisdictionType collects thistax. nonTaxable The amount of the transaction Decimal that wasnon-taxable. rate Tax Rate - The rate of Decimal taxation, as a fractionof the amount. rateType (DEPRECATED) Indicates the RateType tax ratetype. Please use rateTypeCode instead. rateTypeCode Indicates the codeof the rate String type. Use ‘/api/v2/definitions/ratetypes’ for a fulllist of rate type codes. region Two or three-character ISO Stringregion, state or province code, if applicable. stateAssignedNo The stateassigned a number of String the jurisdiction that collects this tax. taxTax amount − The calculated Decimal tax (Base * Rate). taxable Tax Base− The adjusted Decimal taxable amount. taxAuthorityType The unique ID ofthe Tax Integer Authority Type that collects this tax. PropertiesDescription Data Type taxCalculated Tax Calculated by Avalara DecimalAvaTax. This may be overridden by a TaxOverride. TaxAmount. taxGroupGroup code when special String grouping is enabled. taxName The name ofthe tax. String taxType The tax type of this tax. TaxType

TransactionAddressModel

Description Transaction Address Model.

Properties

The following are the transaction address model properties and theirinformation:

Properties Description Data Type boundaryLevel The boundary level atwhich BoundaryLevel this address was validated. city The city for theaddress. String country The country for the address. String id Theunique ID number of Long this address. latitude Latitude for thisaddress String (CALC - 13394). line1 The first line of the street Stringaddress. line2 The second line of the street String address. line3 Thethird line of the street String address. longitude Longitude for thisaddress String (CALC - 13394). postalcode Postal Code/Zip Code Stringcomponent of the address. region The region, state, or String provincefor the address. taxRegionId The unique ID number of Long the tax regionfor this address. transactionId The unique ID number of Long thedocument to which this address belongs.

TransactionLineModel

Description Transaction Line Model.

Properties

The following are the transaction line model properties and theirinformation:

Properties Description Data Type boundaryOverrideId The unique ID numberof the Long boundary override applied to this line item.businessIdentificationNo VAT business identification String number usedfor this transaction. certificated The CertCapture Certificate ID.String customerUsageType The customer usage type for this String lineitem. Usage type often affects taxability rules. description Adescription of the item or String service represented by this line.destinationAddressId The unique ID number of the Long destinationaddress where this line was delivered or sold. detailsTransactionLineDetailModel[ ] TransactionLineDetailModel Optional: Alist of location types for this line item. To fetch this list, add thequery string “?$include=LineLocationTypes” to your URL. discountAmountThe amount of discount that was Decimal applied to this line item.discountTypeId The type of discount, if any, that Long was applied tothis line item. exemptAmount The amount of this line item that Decimalwas exempt. exemptCertId The unique ID number of the Long exemptioncertificate that applied to this line item. exemptNo If this line itemwas exempt, this String string contains the word ‘Exempt.’ id The uniqueID number of this Long transaction line item. isItemTaxable True if thisitem is taxable. Boolean isSSTP True if this item is a StreamlinedBoolean Sales Tax line item. itemCode The code string of the item Stringrepresented by this line item. lineAmount The total amount of thetransaction, Decimal including both taxable and exempt.lineLocationTypes TransactionLineLocationTypeModel[ ]TransactionLineDetailModel Optional: A list of location types for thisline item. lineNumber The line number or code indicating String the lineon this invoice or receipt or document. originAddressId The unique IDnumber of the origin Long address where this line was delivered or sold.parameters Contains a list of extra parameters String that were set whenthe transaction was created. quantity The quantity of products sold onthis Decimal line item. ref1 A user-defined reference identifier forString this transaction line item. ref2 A user-defined referenceidentifier for String this transaction line item. reportingDate The datewhen this transaction should DateTime be reported. revAccount Therevenue account number for this String line item. sourcing Indicateswhether this line item was Sourcing taxed according to the origin ordestination. tax The amount of tax generated for this Decimal line item.taxableAmount The taxable amount of this line Decimal item.taxCalculated The tax calculated for this line by Decimal Avalara.taxCode The tax calculated for this line by String Avalara. taxCodeIdThe unique ID number for the tax Long code that was used to calculatethis line item. taxDate The date that was used for DateTime calculatingtax amounts for this line item. taxEngine The tax engine identifier thatwas String used to calculate this line item. taxIncluded True if the taxwas included in the Boolean purchase price of the item.taxOverrideAmount If a tax override was specified, Decimal thisindicates the amount of tax that was requested. taxOverrideReason If atax override was specified, String represents the reason for the taxoverride. taxOverrideType If a tax override was specified,TaxOverrideTypeId this indicates the type of tax override. transactionIdThe unique ID number of the Long transaction to which this line itembelongs.

TransactionLineDetailModel

Description Transaction Line Detail Model.

Properties

The following are the transaction line detail model properties and theirinformation:

Properties Description Data Type addressId The unique ID number of theLong address used for this tax detail. country The two-character ISO3166 String country code of the country where this tax detail isassigned. countyFIPS For U.S. transactions, the Federal StringInformation Processing Standard (FIPS) code for the county where thistax detail is assigned. exemptAmount The amount of this line that wasDecimal considered exempt in this tax detail. exemptReasonId The uniqueID number of the Long exemption reason for this tax detail. exemptUnitsA number of units in this line item Decimal that were calculated to beexempt according to this rating detail. id The unique ID number of thistax Long detail. inState True if this detail element Boolean representedan in-state transaction. jurisCode The code of the jurisdiction toString which this tax detail applies. jurisdictionId The unique IDnumber of the Long jurisdiction to which this tax detail applies.jurisName The name of the jurisdiction to String which this tax detailapplies. jurisType The type of the jurisdiction to JurisTypeId whichthis tax detail applies. nonTaxableAmount The amount of this line itemthat Decimal was considered nontaxable in this tax detail.nonTaxableRuleId The rule according to which Long portion of this detailwas considered nontaxable. nonTaxableType The type of nontaxability thatwas TaxRuleTypeId applied to this tax detail. nonTaxableUnits A numberof units in this line item Decimal that were calculated to be nontaxableaccording to this rating detail. rate The rate at which this tax detailDecimal was calculated. rateRuleId The unique ID number of the rule Longaccording to which this tax detail was calculated. rateSourceId Theunique ID number of the Long source of the rate according to which thistax detail was calculated. rateType (DEPRECATED) The rate type forRateType this tax detail. Please use rateTypeCode instead. rateTypeCodeIndicates the code of the rate type String that was used to calculatethis tax detail. region The two or three-character ISO String regioncode for the region where this tax detail is assigned. serCode ForStreamlined Sales Tax String customers, the SST Electronic Return codeunder which this tax detail should be applied. signatureCode TheAvalara-specified signature String code of the jurisdiction to whichthis tax detail applies. sourcing Indicates whether this tax detailSourcing applies to the origin or destination of the transaction.stateAssignedNo The state assigned a number of the String jurisdictionto which this tax detail applies. stateFIPS For U.S. transactions, theFederal String Information Processing Standard (FIPS) code for the statewhere this tax detail is assigned. tax The amount of tax for this taxDecimal detail. taxableAmount The taxable amount of this tax Decimaldetail. taxableUnits A number of units in this line item Decimal thatwere calculated to be taxable according to this rating detail.taxAuthorityTypeId The type of the tax authority to Long which this taxwill be remitted. taxCalculated The amount of tax that was Decimalcalculated. taxName The name of the tax against which String this taxamount was calculated. taxOverride The amount of tax override thatDecimal was specified for this tax line. taxRegionId The unique IDnumber of the tax Long region. taxType The type of tax that wascalculated. TaxType Depends on the company's nexus settings as well asthe jurisdiction's tax laws. transactionId The unique ID number of thisLong transaction. transactionLineId The unique ID number of the lineLong within this transaction.

AddressValidationInfo

Description REST client for Avalara address validation and taxcalculation services. @author Avalara ® Salesforce ® Connector Team.

Properties

The following are the address validation info properties and theirinformation:

Properties Description Data Type city City component of the Stringaddress. country Name or ISO 3166 code String identifying the country.latitude Geospatial latitude Double measurement, in Decimal Degrees,floating point format. line1 The first line of the street Stringaddress. line2 The second line of the street String address. line3 Thethird line of the street String address. longitude Geospatial longitudeDouble measurement, in Decimal Degrees, floating point format.postalcode Postal Code/Zip Code String component of the address. regionName or ISO 3166 code String identifying the region within the country.textcase Specify the text case for the TextCase validated addressresult. If not specified, it returns uppercase. = [‘Upper’, ‘Mixed’].

CreateTransactionModel

Description Create Transaction Model.

Properties

The following are the create transaction model properties and theirinformation:

Properties Description Data Type addresses Default addresses for allAddressesModel lines in this document. batchCode BatchCode for batchString operations. businessIdentificationNo VAT business identificationString number for the customer for this transaction. code TransactionCode - the String internal reference code used by the clientapplication. commitDocument Causes the document to be Boolean committedif true. companyCode Company Code - Specify String the code of thecompany creating this transaction here. currencyCode The three-characterISO String 4217 currency code for this transaction. customerCode Theclient application String customer reference code. customerUsageTypeCustomer Usage Type - The String client application customer or usagetype. debugLevel If the user wishes to request TaxDebugLevel additionaldebug information from this transaction, specify a level higher than‘normal.’ description User-supplied description String for thistransaction. discount The discount amount to Decimal apply to thedocument. documentDate The date on the invoice, DateTime purchase order.email User-supplied email address String relevant for this transaction.exchangeRate Currency exchange rate Decimal from this transaction to thecompany base currency. exchangeRateEffectiveDate The effective date ofthe DateTime exchange rate. exemptionNo Exemption Number for this Stringdocument. isSellerImporterOfRecord Specifies if the Transaction Booleanhas the seller as IsSellerImporterOfRecord. lines Document line itemslist. LineItemModel parameters Special parameters for this Stringtransaction. posLaneCode Sets the Point of Sale Lane String Code sent bythe User for this document. purchaseOrderNo Purchase Order Number forString this document. referenceCode Customer-provided String ReferenceCode with information about this transaction. reportingLocationCode Setsthe sale location code String (Outlet ID) for reporting this document tothe tax authority. salespersonCode Salesperson Code - The String clientapplication salesperson reference code. serviceMode Specifies whetherthe tax ServiceMode calculation is handled Local, Remote, or Automatic(default). taxOverride Specifies a tax override for TaxOverrideModel theentire document. type Specifies the type of DocumentType document tocreate.

AddressesModel

Description Wrapper for Address data.

Properties

The following are the addresses model properties and their information:

Properties Description Data Type pointOfOrderAcceptance The place ofbusiness where AddressLocationInfo you accept/approve the customer ™”sorder, thereby becoming contractually obligated to make the sale.pointOfOrderOrigin The place of business where AddressLocationInfo youreceive the customer's order. shipFrom The origination addressAddressLocationInfo where the products were shipped from, or from wherethe services originated. shipTo The destination addressAddressLocationInfo where the products were shipped to, or where theservices were delivered. singleLocation If this transaction occurredAddressLocationInfo at a retail point-of-sale location, provide thatsingle address here and leave all other address types null.

AddressLocationInfo

Description Informational about Address data.

Properties

The following are the addresses location info properties and theirinformation:

Properties Description Data Type city City component of the Stringaddress. country Two-character ISO 3166 String Country Code. Call‘ListCountries' for a list of ISO 3166 country codes. latitudeGeospatial latitude Decimal measurement, in Decimal Degrees, floatingpoint format. line1 The first line of the street String address. line2The second line of the street String address. line3 The third line ofthe street String address. locationCode If you wish to use the Stringaddress of an existing location for this company, specify the addresshere. longitude Geospatial longitude Decimal measurement, in DecimalDegrees, floating point format. postalCode Postal Code/Zip Code Stringcomponent of the address. region State/Province/Region String componentof the address.

LineItemModel

Description Line Item Model

Properties

The following are the line item model properties and their information:

Properties Description Data Type addresses The addresses to use for thisAddressesModel transaction line. amount The total amount for thisDecimal line. businessIdentificationNo VAT business identificationString number for the customer for this line item. customerUsageTypeCustomer Usage Type - The String client application customer or usagetype. description Item description. This is String required for SSTtransactions if an unmapped ItemCode is used. discounted True if thedocument discount should be applied Boolean to this line. exemptionCodeExemption number for this String line. itemCode Item Code (SKU). StringlineNumber Line number within this String document. quantity Quantity ofitems in this Decimal line. ref1 Reference 1 - Client specific Stringreference field. ref2 Reference 2 - Client specific String referencefield. revenueAccount Revenue Account. String taxCode Tax Code - Systemor String Custom Tax Code. taxIncluded Indicates if the line has TaxBoolean Included; defaults to false.

TaxOverrideModel

Description Tax Override Model.

Properties

The following are the tax override model properties and theirinformation:

Properties Description Data Type reason This provides the reason forString a tax override for audit purposes. taxAmount Indicates a totaloverride of Decimal the calculated tax on the document. taxDate Theoverride tax date to use. Decimal type Identifies the type of taxTaxOverrideType override.

CommitTransactionModel

Description Commit Transaction Model.

Properties

The following are the commit transaction model properties and theirinformation:

Properties Description Data Type commitTransaction Set this value to betrue to Boolean commit this transaction.

VoidTransactionModel

Description Void Transaction Model.

Properties

The following are the void transaction model properties and theirinformation:

Properties Description Data Type code Please specify the reason forVoidReasonCode voiding or canceling this transaction.

Enums

BoundaryLevel

Description The boundary level at which this address was validated.

Properties

The following are the transaction address model properties and theirinformation:

Properties Description Address Street address precision. Zip9 9-digitzip precision. Zip5 5-digit zip precision.

DocumentType

Description Document Type for Tax Calculation Return NA

Properties

The following are the document type properties and their information:

Properties Description SalesOrder Sales Order estimate or quote(default). This is a temporary document type and is not saved in taxhistory. SalesInvoice Sales Invoice. PurchaseOrder Purchase order,estimate, or quote. This is a temporary document type and is not savedin tax history. PurchaseInvoice Purchase Invoice. ReturnOrder SalesReturn Order. This is a temporary document type and is not saved in taxhistory. ReturnInvoice Sales Return Invoice. InventoryTransferOrderInventory Transfer Order. InventoryTransferInvoice Inventory TransferInvoice. ReverseChargeOrder Reverse Charge Order. Properties DescriptionReverseChargeInvoice Reverse Charge Invoice. AnyDocumentType Noparticular type.

TaxOverrideTypeId

Description Tax Override Type Id for Tax Calculation. Return NA

Properties

The following are the document type properties and their information:

Properties Description None No override. TaxAmount The tax wasoverridden by the client. Exemption Entity exemption was ignored (Forexample, consumed item). TaxDate Only the tax date was overridden.AccruedTaxAmount To support Consumer Use Tax. DeriveTaxable Derive thetaxable amount from the tax amount.

VoidReasonCode

Description Void Reason Code.

Properties

The following are the void reason code properties and their information:

Properties Description Unspecified Unspecified reason. PostFailed Postoperation failed - Document status will be changed to unposted.DocDeleted Document deleted - If committed, document status will bechanged to Cancelled. DocVoided The document has been voided, andDocStatus will be set to Cancelled. AdjustmentCancelled The adjusttaxoperation has been canceled. The adjustment will be reversed.

TaxOverrideType

Description Tax Override Type for Tax Calculation. Return NA

Properties

The following are the tax override type properties and theirinformation:

Properties Description None No override. TaxAmount The tax wasoverridden by the client. Exemption Entity exemption was ignored (Forexample, consumed item). TaxDate Only the tax date was overridden.AccruedTaxAmount To support Consumer Use Tax. Derive the taxable amountfrom the tax DeriveTaxable amount.

TaxDebugLevel

Description Tax Debug Level for Tax Calculation. Return NA

Properties

The following are the tax debug level properties and their information:

Properties Description Normal User requests the normal level ofdebugging information when creating a tax transaction. Diagnostic Userrequests additional diagnostic information when creating a taxtransaction.

AdjustmentReason

Description Adjustment Reason for Tax Calculation. Return NA

Properties

The following are the adjustment reason properties and theirinformation:

Properties Description NotAdjusted The transaction has not beenadjusted. SourcingIssue A sourcing issue existed which caused thetransaction to be adjusted. ReconciledWithGeneralLedger The transactionwas adjusted to reconcile it with a general ledger. ExemptCertAppliedThe transaction was adjusted after an exemption certificate was applied.PriceAdjusted The transaction was adjusted when the price of an itemchanged. ProductReturned The transaction was adjusted due to a productreturn. ProductExchanged The transaction was adjusted due to a productexchange. BadDebt The transaction was adjusted due to bad oruncollectable debt. Other The transaction was adjusted for anotherreason not specified.

DocumentStatus

Description Document Status for Tax Calculation. Return NA

Properties

The following are the document status properties and their information:

Properties Description SalesOrder Sales Order estimate or quote(default). This is a temporary document type and is not saved in taxhistory. SalesInvoice Sales Invoice. PurchaseOrder Purchase order,estimate, or quote. This is a temporary document type and is not savedin tax history. PurchaseInvoice Purchase Invoice. ReturnOrder SalesReturn Order. This is a temporary document type and is not saved in taxhistory. ReturnInvoice Sales Return Invoice. InventoryTransferOrderInventory Transfer Order. InventoryTransferInvoice Inventory TransferInvoice. ReverseChargeOrder Reverse Charge Order. ReverseChargeInvoiceReverse Charge Invoice. AnyDocumentType No type.

JurisdictionType

Description The type of jurisdiction referenced by the tax authority.

Properties

The following are the jurisdiction type properties:

Properties Country Composite State County City Special

JurisTypeId

Description Juris Type Id for Tax Calculation. Return NA

Properties

The following are the juris type id properties and their information:

Properties Description STA State CTY County CIT City STJ Special CNTCountry

RateType

Description Rate Type for Tax Calculation. Return NA

Properties

The following are the rate type properties:

Properties ReducedA ReducedB Food General IncreasedStandard LinenRentalMedical Parking SuperReduced ReducedR Standard Zero

ResolutionQuality

Description The resolution quality of the geospatial coordinates. ReturnNA

Properties

The following are the resolution quality properties:

Properties NotCoded External CountryCentroid RegionCentroidPartialCentroid PostalCentroidGood PostalCentroidBetterPostalCentroidBest Intersection Interpolated Rooftop Constant

TaxRuleTypeId

Description Tax Rule Type Id.

Properties

The following are the tax rule type id properties:

Properties RateRule RateOverrideRule BaseRule ExemptEntityRuleProductTaxabilityRule NexusRule

TaxType

Description Tax Type.

Properties

The following are the tax type properties and their information:

Properties Description Lodging Match Lodging tax type. Bottle Matchbottle tax type. EWaste EWaste tax type. ConsumerUse Consumer Use Tax.Excise Medical Excise Tax. Fee Fee - PIFs (global Improvement Fees) andRSFs (Retail Sales Fees). Input VAT/GST Input tax. NonrecoverableVAT/GST Nonrecoverable Input tax. Output VAT/GST Output tax. RentalRental Tax. Sales Sales tax. Use Use Tax.

Sourcing

Description Sourcing for Tax Calculation.

Properties

The following are the sourcing properties and their information:

Properties Description Mixed Mixed sourcing, for states that do bothorigin and destination calculation. Destination Destination OriginOrigin

ServiceMode

Description Service Mode

Properties

The following are the service mode properties and their information:

Properties Description Automatic Automatically use local or remote(default). Local The local server only. Remote Remote server only.

PostTaxCalculator

Description Contains methods for Posting tax and updating back toSalesforce object. It reads XML configuration provide and generate post-tax calculation request from the mapping provided in XML configurationfile. It supports several hooks that can be subscribed to modify the taxcalculation request as per business requirement.

Properties

The following are the post-tax calculator properties and theirinformation:

Properties Description Data Type headerQueryResult Stores query wiseresult of String SOQL defined underTaxCalculator− >SalesforceObject−>Header− >Queries node. lineQueryResultStores query wise result of String SOQL defined underTaxCalculator− >SalesforceObject−>Line− >Queries node.

Methods

executeQuery

Description Retrieves Data from Salesforce. It also reads all theQueries in XML config provided for the calling package. Moreover, keepit ready for further usage in tax calculation. Returns NA ParametersModel An instance of QueryInput. postTax Description This method isresponsible for document posting. It formulates the posting document forthe calling package. Moreover, provide the Post-Tax Calculation resultto the Connector. Returns An instance of TransactionModel. ParametersModel Instance of PostTaxCalculationInput. PostTaxCalculator DescriptionIt initializes an instance of PostTaxCalculator class for the Salesforceobject provided. It also reads all the XML config provided for thecalling package. Moreover, keep it ready for further usage in documentposting. Returns An instance of TaxCalculator class. ParametersCallingPackage Name of the package which wants to calculate the tax.Model AvaTax Configuration details.

setConfigProviderListener

Description Hook Method for getting the config before Post TaxCalculation Returns None Parameters Model Instance ofIConfigManagerPost.

Models

QueryInput

Properties

The following are the query input properties and their information:

Properties Description Data Type controller Name of the object Stringcontroller. optionalParams Data required for creating Map<String,String> parameters in the query. recordId Id of the Salesforce record.Id

PostTaxCalculationInput

Description Post Tax details essential for Committing the document.

Properties

The following are the post-tax calculator input properties and theirinformation:

Properties Description Data Type commitFlag Flag to commit document,VoidReasonCode Value can true or false companyCode CompanyCode forCancel String Tax Calculation. docType DocType for Cancel TaxDocumentType Calculation. transactionCode TransactionCode for CancelString Tax Calculation.

TaxCalulator

Description Contains methods for calculating tax and updating back toSalesforce object. It reads XML configuration provide and generate taxcalculation request from the mapping provided in XML configuration file.It supports several hooks that can be subscribed to modify the taxcalculation request as per business requirement.

Properties

The following are the tax calculator properties and their information:

Properties Description Data Type headerQueryResult Stores query wiseresult of String SOQL defined underTaxCalculator− >SalesforceObject−>Header− >Queries node. lineQueryResultStores query wise result of String SOQL defined underTaxCalculator− >SalesforceObject−>Line− >Queries node.

Methods

TaxCalulator

Description It initializes an instance of TaxCalculator class for theSalesforce object provided. It also reads all the XML config providedfor the calling package. Moreover, keep it ready for further usage intax calculation. Returns An instance of TaxCalculator class. ParametersCallingPackage name of the package which wants to calculate the tax.Config AvaTax Configuration details

calculateTax

Description This method is responsible for Tax Calculation. Itformulates the Tax for the calling package. Moreover, provide the TaxCalculation result to the Connector. Returns An instance ofTransactionModel. Parameters Model Instance of TaxCalculationInput.

setBeforeTaxCalculationListener

Description Hook Method for editing the header data of Tax Requestbefore Tax Calculation. Returns None Parameters Model Instance ofIBeforeTaxCalculation.

setBeforeTaxValidationListener

Description Hook Method for validations if any to be done before actualbefore Tax Calculation. Returns None Parameters Model Instance ofIBeforeTaxValidation.

setConfigProviderListener

Description Hook Method for getting the config before Tax Calculation.Returns None Parameters Model Instance of IBeforeTaxValidation.

setOverrideRequestLineListener

Description Hook Method for editing the line data of Tax Request beforeTax Calculation Returns None Parameters Model Instance ofIOverrideRequestLine.

Models

TaxCalculationInput

Properties

The following are the tax calculation input properties and theirinformation:

Properties Description Data Type commitFlag Flag for committing Booleandocument on AvaTax. controller Name of the Salesforce String object.docType AvaTax Document Type. DocumentType optionalParams Data requiredfor creating String parameters in the query. recordId The id of theSalesforce Id record.

CancelTaxCalculator

Description Contains methods for canceling tax and updating back toSalesforce object.

Properties

The following are the cancel tax calculator properties and theirinformation:

Properties Description Data Type headerQueryResult Stores query wiseresult of Map<String,List<SObject>> SOQL defined underTaxCalculator− >SalesforceObject−>Header− >Queries node.

Methods

cancelTax

Description This method is responsible for Tax Calculation. Returns Aninstance of TransactionModel. Param An instance ofCancelTaxCalculationInput.

CancelTaxCalculator

Description Initializes an instance of CancelTaxCalculator class for theSalesforce object provided. Returns An instance of TaxCalculator class.Parameters CallingPackage name of the package which wants to calculatethe tax. Config AvaTax Configuration details

Models

CancelTaxCalculationInput

Description Cancel Tax details essential for Voiding the document. Taxcalculation is affected by these details.

Properties

The following are the cancel tax calculator input properties and theirinformation:

Properties Description Data Type code VoidReasonCode for CancelVoidReasonCode Tax Calculation. companyCode CompanyCode for CancelString Tax Calculation. controller Controller for Cancel Tax StringCalculation. docType DocType for Cancel Tax DocumentType Calculation.optionalParams OptionalParams for Cancel Map<String, String> TaxCalculation, One can specify if any extra parameters need to be sent toAvaTax Service. recordId RecordId for Cancel Tax Id Calculation.transactionCode TransactionCode for Cancel String Tax Calculation.

ConfigurationBase

Description Abstract class for Configuration

Properties

The following are the configuration base properties and theirinformation:

Properties Description Data Type accountId Specify the accountId forInteger validating in AvaTax. appName Specify the Application StringName. appVersion Specify the Application String Version. companyCodeSpecify the code of the String company creating this transaction here.defaultOriginAddress Specify the instance of AddressValidationInfoAddressValidationInfo for Origin Address. environment AvaTaxEnvironmentfor AvaTaxEnvironment Tax Calculation. isAddressValidationEnabledSpecify if the Address Boolean Validation is Enabled.isDateOverrideAllowed Specify whether Transaction Boolean Date can beoverridden. isTaxCalculationEnabled Specify if the Tax BooleanCalculation is Enabled. isUPCEnabled Specify whether the UPC Boolean TaxCode is allowed. licenseKey Specify the licenseKey for String validatingin AvaTax. password Specify the Password for String validating inAvaTax. restClientName Specify the Client Name. StringreturnAddressInUpperCase Returns Address Validation Boolean result inUpper Case. saveTransactionToAvaTax Specify whether to record Booleanthe document to Avatax. Username Specify the Username for Stringvalidating in AvaTax.

Enums

AvaTaxEnvironment

Description AvaTaxEnvironment for Tax Calculation Return NA

Properties

The following are the configuration base properties and theirinformation:

Properties Description Sandbox Development Environment. ProductionProduction Environment.

In some embodiments, the system may present a user interface to displayinformation to a user and receive user input. The user input may be usedto generate or modify a configuration file (e.g., in XML format) asdescribed above. Examples of such a user interface are depicted below,which may be referred to as the “AvaTax Mapper Studio” or “MapperStudio.”

Avalara AvaTax Mapper Studio is a user interface to generate a modifiedconfig XML. You can manage or edit your integration points for AvaTaxMapper to work. The Mapper Studio has the following capabilities:

-   -   User can add new integration points (object) and new fields for        address validation, tax calculation, and cancel tax calculation.    -   Remove the existing integration point.    -   Define hooks for functionality modification.    -   Validate query and fetch parameters from a query for defining        its source value.    -   User interface works on a point and click method.    -   User can define the classes for hooks.

Steps to Open AvaTax Mapper Studio

Go to Setup->Installed Packages->Configure (AvaTax For SalesforceCPQ+)->Advanced Settings->Under Additional Settings, Click Launch MapperStudio. The screen depicted in FIG. 7G may be viewed on a new tab.

Mapper Studio

After you open the Mapper Studio, you can view the AvaTaxfunctionalities on the user interface.

On the Mapper Studio Avalara AvaTax provides integrations on thefollowing functionalities:

Address Validation

Tax Calculation

Cancel Tax Calculation

Note: Address Validation tab is the default tab.

Integration Points

To add the integration points:

Avalara has enlisted the supported integration points in the MapperStudio.

Default integrations are:

Order

Account

Contract

SBQQ_Quote_c

Click the plus icon

to add a new integration point (object).

SELECT NEW OBJECT NAME dialog box opens.

Select the object from the dropdown list, and click Add to add theobject.

Under object, click the plus icon

to add a new field.

ADD NEW FIELD DETAILS dialog box opens.

Type the address in the test box and click Add.

Click the delete icon

, and click Delete on the Delete dialog box to delete an object.

Click the delete icon

, and click Delete on the Delete dialog box to delete the field.

How to Create Additional Integration Point (objects) and Fields:

Steps to create additional integration point (objects) and fields:

ADDRESSVALIDATION

Click the plus icon

to add an additional integration point (object) as depicted in FIG. 7H.The SELECT NEW OBJECT NAME dialog box opens, and the user may select theobject from the dropdown list, and click Add to add the object asdepicted in FIG. 7I. Under object, click the plus icon

to add a new field, as depicted in FIG. 7J.

The ADD NEW FIELD DETAILS dialog box opens. Type the address in the testbox and click Add as depicted in FIG. 7K.

TAXCALCULATION

Click the plus icon

to add an additional integration point (object) as depicted in FIG. 7H.The SELECT NEW OBJECT NAME dialog box opens. Select the object from thedropdown list, and click Add to add the object as depicted in FIG. 7I.

Click the plus icon

on Header and Line Queries of integration point (object) to add a newobject at header and line level as depicted in FIG. 7J. The ADD NEWFIELD DETAILS dialog box opens. Select the object from the dropdownlist, and click Add to add the object as depicted in FIG. 7K.

CANCELTAXCALCULATION

Click the plus icon

to add an additional integration point (object) as depicted in FIG. 7H.SELECT NEW OBJECT NAME dialog box opens. Select the object from thedropdown list, and click Add to add the object as depicted in FIG. 7I.Click the plus icon

on Queries of integration point (object) to add a new object at querylevel as depicted in FIG. 7L. The ADD NEW FIELD DETAILS dialog boxopens. Select the object from the dropdown list, and click Add to addthe object as depicted in FIG. 7M

Hooks

Hooks are the facility to customize the logic before or after taxcalculation. Hooks varies from functional tabs.

The following types of hooks for tabs:

Hooks for Address Validation

Click the setting icon

to add new hook class in the integration point as depicted in FIG. 7N.Note: Avalara has defined the default sets of hook class. Click the editicon

to type the definition of the hook as depicted in FIG. 7O and ClickSave.

Hooks for Tax Calculation

Click the setting icon

to add new hook class in the integration point as depicted in FIG. 7P.Note: Avalara has defined the default sets of hook class. Click the editicon

to type the definition of the hook as depicted in FIG. 7Q and ClickSave. Note: After every execution you must click Save as XML to saveyour changes, otherwise, it will temporarily delete the object/field,but resides in config XML.

How to Map Request and Response Mapping(s):

Whenever you add a new integration point, or you want to make changes inthe request and response mappings, and then click on the object/fieldunder integration point.

Go to ADDRESSVALIDATION->Order->Billing.

Addressvalidation is a functionality, order is integration point onaddressvalidation, and billing is the type of address.

Click Billing, to view the different sections on the right side which isshown below:

Query for Billing

It is placeholder where a user can enter/modify a Salesforce ObjectQuery Language (SOQL), which gets validated with the help of salesforce.If a query is not valid, then its display an alert, or else, it fetchedthe parameter's data from the query, and displays the request andresponse mapping as depicted in FIG. 7R.

Query Parameters

This section gets list of all the parameters which are entered in query‘{ }’. You can define its data, either it can be an Id, OptParams(optional param), or object as depicted in FIG. 7S.

AvaTax Request Mapping(s)

The mapping diagram in FIG. 7D illustrates an example of requestmapping. In this example, billing fields are mapped with AvaTax, whichmeans the data entered in the BillingStreet is mapped with line1 ofAvaTax, and it is passed to the request. It is the same for the rest ofthe fields. The arrows in FIG. 7D depict the mapping of the “Billing”fields on the left to the “AvaTax” fields on the right. The mapping ofthe fields in FIG. 7D is exemplary only. In alternate embodiments, therequest fields may be mapped (and such mappings modified) in anysuitable manner.

AvaTax Response Mapping(s)

FIG. 7E illustrates and example of an update mapping diagram forresponse mapping. In this example, AvaTax fields on the left are mappedwith Billing fields on the right. In this example, a response receivedfrom AvaTax service call in line 1 is shown in BillingStreet. It is samefor the remaining fields. As with the request mappings described above,the response fields may be mapped (and such mappings modified) in anysuitable manner.

Software and System Architectures

FIG. 8 is a block diagram illustrating an exemplary softwarearchitecture 806, which may be used in conjunction with various hardwarearchitectures herein described. FIG. 8 is a non-limiting example of asoftware architecture and it will be appreciated that otherarchitectures may be implemented to facilitate the functionalitydescribed herein. The software architecture 806 may execute on hardwaresuch as machine 900 of FIG. 9 that includes, among other things,processors 904, memory 914, and I/O components 918. A representativehardware layer 852 is illustrated and can represent, for example, themachine 900 of FIG. 9. The representative hardware layer 852 includes aprocessing unit 854 having associated executable instructions 804.Executable instructions 804 represent the executable instructions of thesoftware architecture 806, including implementation of the methods,components and so forth described herein. The hardware layer 852 alsoincludes memory and/or storage modules memory/storage 856, which alsohave executable instructions 804. The hardware layer 852 may alsocomprise other hardware 858.

As used herein, a “component” may refer to a device, physical entity orlogic having boundaries defined by function or subroutine calls, branchpoints, application program interfaces (APIs), or other technologiesthat provide for the partitioning or modularization of particularprocessing or control functions. Components may be combined via theirinterfaces with other components to carry out a machine process. Acomponent may be a packaged functional hardware unit designed for usewith other components and a part of a program that usually performs aparticular function of related functions. Components may constituteeither software components (e.g., code embodied on a machine-readablemedium) or hardware components. A “hardware component” is a tangibleunit capable of performing certain operations and may be configured orarranged in a certain physical manner. In various exemplary embodiments,one or more computer systems (e.g., a standalone computer system, aclient computer system, or a server computer system) or one or morehardware components of a computer system (e.g., a processor or a groupof processors) may be configured by software (e.g., an application orapplication portion) as a hardware component that operates to performcertain operations as described herein.

A hardware component may also be implemented mechanically,electronically, or any suitable combination thereof. For example, ahardware component may include dedicated circuitry or logic that ispermanently configured to perform certain operations. A hardwarecomponent may be a special-purpose processor, such as aField-Programmable Gate Array (FPGA) or an Application SpecificIntegrated Circuit (ASIC). A hardware component may also includeprogrammable logic or circuitry that is temporarily configured bysoftware to perform certain operations. For example, a hardwarecomponent may include software executed by a general-purpose processoror other programmable processor. Once configured by such software,hardware components become specific machines (or specific components ofa machine) uniquely tailored to perform the configured functions and areno longer general-purpose processors. It will be appreciated that thedecision to implement a hardware component mechanically, in dedicatedand permanently configured circuitry, or in temporarily configuredcircuitry (e.g., configured by software) may be driven by cost and timeconsiderations. Accordingly, the phrase “hardware component” (or“hardware-implemented component”) should be understood to encompass atangible entity, be that an entity that is physically constructed,permanently configured (e.g., hardwired), or temporarily configured(e.g., programmed) to operate in a certain manner or to perform certainoperations described herein. Considering embodiments in which hardwarecomponents are temporarily configured (e.g., programmed), each of thehardware components need not be configured or instantiated at any oneinstance in time. For example, where a hardware component comprises ageneral-purpose processor configured by software to become aspecial-purpose processor, the general-purpose processor may beconfigured as respectively different special-purpose processors (e.g.,comprising different hardware components) at different times. Softwareaccordingly configures a particular processor or processors, forexample, to constitute a particular hardware component at one instanceof time and to constitute a different hardware component at a differentinstance of time. Hardware components can provide information to, andreceive information from, other hardware components. Accordingly, thedescribed hardware components may be regarded as being communicativelycoupled.

Where multiple hardware components exist contemporaneously,communications may be achieved through signal transmission (e.g., overappropriate circuits and buses) between or among two or more of thehardware components. In embodiments in which multiple hardwarecomponents are configured or instantiated at different times,communications between such hardware components may be achieved, forexample, through the storage and retrieval of information in memorystructures to which the multiple hardware components have access. Forexample, one hardware component may perform an operation and store theoutput of that operation in a memory device to which it iscommunicatively coupled. A further hardware component may then, at alater time, access the memory device to retrieve and process the storedoutput. Hardware components may also initiate communications with inputor output devices, and can operate on a resource (e.g., a collection ofinformation). The various operations of exemplary methods describedherein may be performed, at least partially, by one or more processorsthat are temporarily configured (e.g., by software) or permanentlyconfigured to perform the relevant operations. Whether temporarily orpermanently configured, such processors may constituteprocessor-implemented components that operate to perform one or moreoperations or functions described herein. As used herein,“processor-implemented component” refers to a hardware componentimplemented using one or more processors. Similarly, the methodsdescribed herein may be at least partially processor-implemented, with aparticular processor or processors being an example of hardware. Forexample, at least some of the operations of a method may be performed byone or more processors or processor-implemented components. Moreover,the one or more processors may also operate to support performance ofthe relevant operations in a “cloud computing” environment or as a“software as a service” (SaaS). For example, at least some of theoperations may be performed by a group of computers (as examples ofmachines including processors), with these operations being accessiblevia a network (e.g., the Internet) and via one or more appropriateinterfaces (e.g., an Application Program Interface (API)). Theperformance of certain of the operations may be distributed among theprocessors, not only residing within a single machine, but deployedacross a number of machines. In some exemplary embodiments, theprocessors or processor-implemented components may be located in asingle geographic location (e.g., within a home environment, an officeenvironment, or a server farm). In other exemplary embodiments, theprocessors or processor-implemented components may be distributed acrossa number of geographic locations.

In the exemplary architecture of FIG. 8, the software architecture 806may be conceptualized as a stack of layers where each layer providesparticular functionality. For example, the software architecture 806 mayinclude layers such as an operating system 802, libraries 820,applications 816 and a presentation layer 814. Operationally, theapplications 816 and/or other components within the layers may invokeapplication programming interface (API) API calls 808 through thesoftware stack and receive a response as in response to the API calls808. The layers illustrated are representative in nature and not allsoftware architectures have all layers. For example, some mobile orspecial purpose operating systems may not provide aframeworks/middleware 818, while others may provide such a layer. Othersoftware architectures may include additional or different layers.

The operating system 802 may manage hardware resources and providecommon services. The operating system 802 may include, for example, akernel 822, services 824 and drivers 826. The kernel 822 may act as anabstraction layer between the hardware and the other software layers.For example, the kernel 822 may be responsible for memory management,processor management (e.g., scheduling), component management,networking, security settings, and so on. The services 824 may provideother common services for the other software layers. The drivers 826 areresponsible for controlling or interfacing with the underlying hardware.For instance, the drivers 826 include display drivers, camera drivers,Bluetooth® drivers, flash memory drivers, serial communication drivers(e.g., Universal Serial Bus (USB) drivers), Wi-Fi® drivers, audiodrivers, power management drivers, and so forth depending on thehardware configuration.

The libraries 820 provide a common infrastructure that is used by theapplications 816 and/or other components and/or layers. The libraries820 provide functionality that allows other software components toperform tasks in an easier fashion than to interface directly with theunderlying operating system 802 functionality (e.g., kernel 822,services 824 and/or drivers 826). The libraries 820 may include systemlibraries 844 (e.g., C standard library) that may provide functions suchas memory allocation functions, string manipulation functions,mathematical functions, and the like. In addition, the libraries 820 mayinclude API libraries 846 such as media libraries (e.g., libraries tosupport presentation and manipulation of various media format such asMPREG4, H.264, MP3, AAC, AMR, JPG, PNG), graphics libraries (e.g., anOpenGL framework that may be used to render 2D and 3D in a graphiccontent on a display), database libraries (e.g., SQLite that may providevarious relational database functions), web libraries (e.g., WebKit thatmay provide web browsing functionality), and the like. The libraries 820may also include a wide variety of other libraries 848 to provide manyother APIs to the applications 816 and other softwarecomponents/modules.

The frameworks/middleware 818 (also sometimes referred to as middleware)provide a higher-level common infrastructure that may be used by theapplications 816 and/or other software components/modules. For example,the frameworks/middleware 818 may provide various graphic user interface(GUI) functions, high-level resource management, high-level locationservices, and so forth. The frameworks/middleware 818 may provide abroad spectrum of other APIs that may be utilized by the applications816 and/or other software components/modules, some of which may bespecific to a particular operating system 802 or platform.

The applications 816 include built-in applications 838 and/orthird-party applications 840. Examples of representative built-inapplications 838 may include, but are not limited to, a contactsapplication, a browser application, a book reader application, alocation application, a media application, a messaging application,and/or a game application. Third-party applications 840 may include anapplication developed using the ANDROID™ or IOS™ software developmentkit (SDK) by an entity other than the vendor of the particular platform,and may be mobile software running on a mobile operating system such asIOS™, ANDROID™ WINDOWS® Phone, or other mobile operating systems. Thethird-party applications 840 may invoke the API calls 808 provided bythe mobile operating system (such as operating system 802) to facilitatefunctionality described herein.

The applications 816 may use built in operating system functions (e.g.,kernel 822, services 824 and/or drivers 826), libraries 820, andframeworks/middleware 818 to create user interfaces to interact withusers of the system. Alternatively, or additionally, in some systemsinteractions with a user may occur through a presentation layer, such aspresentation layer 814. In these systems, the application/component“logic” can be separated from the aspects of the application/componentthat interact with a user.

FIG. 9 is a block diagram illustrating components of a machine 900,according to some exemplary embodiments, able to read instructions froma machine-readable medium (e.g., a computer-readable storage medium) andperform any of the processes, methods, and/or functionality discussedherein. Specifically, FIG. 9 shows a diagrammatic representation of themachine 900 in the exemplary form of a computer system, within whichinstructions 910 (e.g., software, a program, an application, an applet,an app, or other executable code) for causing the machine 900 to performany one or more of the methodologies discussed herein may be executed.As such, the instructions 910 may be used to implement modules orcomponents described herein. The instructions 910 transform the general,non-programmed machine 900 into a particular machine 900 programmed tocarry out the described and illustrated functions in the mannerdescribed.

In some embodiments, the machine 900 operates as a standalone device ormay be coupled (e.g., networked) to other machines. In a networkeddeployment, the machine 900 may operate in the capacity of a servermachine or a client machine in a server-client network environment, oras a peer machine in a peer-to-peer (or distributed) networkenvironment. The machine 900 may be or include, but is not limited to, aserver computer, a client computer, a personal computer (PC), a tabletcomputer, a laptop computer, a netbook, a set-top box (STB), a personaldigital assistant (PDA), an entertainment media system, a cellulartelephone, a smart phone, a mobile device, a wearable device (e.g., asmart watch), a smart home device (e.g., a smart appliance), other smartdevices, a web appliance, a network router, a network switch, a networkbridge, or any machine capable of executing the instructions 910,sequentially or otherwise, that specify actions to be taken by machine900. Further, while only a single machine 900 is illustrated, the term“machine” or “computer system” shall also be taken to include acollection of machines or computer systems that individually or jointlyexecute the instructions 910 to perform any of the methodologiesdiscussed herein.

The machine 900 may include processors 904, memory memory/storage 906,and I/O components 918, which may be configured to communicate with eachother, such as via bus 902. The memory/storage 906 may include a memory914, such as a main memory, or other memory storage, and a storage unit916, both accessible to the processors 904 such as via the bus 902. Inthis context, a “processor” may refer to any circuit or virtual circuit(a physical circuit emulated by logic executing on an actual processor)that manipulates data values according to control signals (e.g.,“commands”, “op codes”, “machine code”, etc.) and which producescorresponding output signals that are applied to operate a machine. Aprocessor may, for example, be a Central Processing Unit (CPU), aReduced Instruction Set Computing (RISC) processor, a ComplexInstruction Set Computing (CISC) processor, a Graphics Processing Unit(GPU), a Digital Signal Processor (DSP), an Application SpecificIntegrated Circuit (ASIC), a Radio-Frequency Integrated Circuit (RFIC)or any combination thereof. A processor may further be a multi-coreprocessor having two or more independent processors (sometimes referredto as “cores”) that may execute instructions contemporaneously.

The storage unit 916 and memory 914 store the instructions 910 embodyingany one or more of the methodologies or functions described herein. Theinstructions 910 may also reside, completely or partially, within thememory 914, within the storage unit 916, within at least one of theprocessors 904 (e.g., within the processor's cache memory), or anysuitable combination thereof, during execution thereof by the machine900. Accordingly, the memory 914, the storage unit 916, and the memoryof processors 904 are examples of machine-readable media. In thiscontext, “machine-readable medium” refers to a component, device orother tangible media able to store instructions and data temporarily orpermanently and may include, but is not be limited to, random-accessmemory (RAM), read-only memory (ROM), buffer memory, flash memory,optical media, magnetic media, cache memory, other types of storage(e.g., Erasable Programmable Read-Only Memory (EEPROM)) and/or anysuitable combination thereof. The term “machine-readable medium” shouldbe taken to include a single medium or multiple media (e.g., acentralized or distributed database, or associated caches and servers)able to store instructions. The term “machine-readable medium” shallalso be taken to include any medium, or combination of multiple media,that is capable of storing instructions (e.g., code) for execution by amachine, such that the instructions, when executed by one or moreprocessors of the machine, cause the machine to perform any one or moreof the methodologies described herein. Accordingly, a “machine-readablemedium” refers to a single storage apparatus or device, as well as“cloud-based” storage systems or storage networks that include multiplestorage apparatus or devices. The term “machine-readable medium”excludes signals per se.

The I/O components 918 may include a wide variety of components toreceive input, provide output, produce output, transmit information,exchange information, capture measurements, and so on. The specific I/Ocomponents 918 that are included in a particular machine 900 will dependon the type of machine. For example, portable machines such as mobilephones will likely include a touch input device or other such inputmechanisms, while a headless server machine will likely not include sucha touch input device. It will be appreciated that the I/O components 918may include many other components that are not shown in FIG. 9. The I/Ocomponents 918 are grouped according to functionality merely forsimplifying the following discussion and the grouping is in no waylimiting. In various exemplary embodiments, the I/O components 918 mayinclude output components 926 and input components 928. The outputcomponents 926 may include visual components (e.g., a display such as aplasma display panel (PDP), a light emitting diode (LED) display, aliquid crystal display (LCD), a projector, or a cathode ray tube (CRT)),acoustic components (e.g., speakers), haptic components (e.g., avibratory motor, resistance mechanisms), other signal generators, and soforth. The input components 928 may include alphanumeric inputcomponents (e.g., a keyboard, a touch screen configured to receivealphanumeric input, a photo-optical keyboard, or other alphanumericinput components), point based input components (e.g., a mouse, atouchpad, a trackball, a joystick, a motion sensor, or other pointinginstrument), tactile input components (e.g., a physical button, a touchscreen that provides location and/or force of touches or touch gestures,or other tactile input components), audio input components (e.g., amicrophone), and the like. Collectively, one or more of the I/Ocomponents 918 may be referred to as a “user interface” for receivinginput, and displaying output, to a user. Additionally, the term “userinterface” may be used in other contexts such as, for example, todescribe a graphical user interface (e.g., a window displayed on adisplay screen to receive input from, and display output to, a user).

In further exemplary embodiments, the I/O components 918 may includebiometric components 930, motion components 934, environmentalenvironment components 936, or position components 938 among a widearray of other components. For example, the biometric components 930 mayinclude components to detect expressions (e.g., hand expressions, facialexpressions, vocal expressions, body gestures, or eye tracking), measurebiosignals (e.g., blood pressure, heart rate, body temperature,perspiration, or brain waves), identify a person (e.g., voiceidentification, retinal identification, facial identification,fingerprint identification, or electroencephalogram basedidentification), and the like. The motion components 934 may includeacceleration sensor components (e.g., accelerometer), gravitation sensorcomponents, rotation sensor components (e.g., gyroscope), and so forth.The environment components 936 may include, for example, illuminationsensor components (e.g., photometer), temperature sensor components(e.g., one or more thermometer that detect ambient temperature),humidity sensor components, pressure sensor components (e.g.,barometer), acoustic sensor components (e.g., one or more microphonesthat detect background noise), proximity sensor components (e.g.,infrared sensors that detect nearby objects), gas sensors (e.g., gasdetection sensors to detection concentrations of hazardous gases forsafety or to measure pollutants in the atmosphere), or other componentsthat may provide indications, measurements, or signals corresponding toa surrounding physical environment. The position components 938 mayinclude location sensor components (e.g., a Global Position system (GPS)receiver component), altitude sensor components (e.g., altimeters orbarometers that detect air pressure from which altitude may be derived),orientation sensor components (e.g., magnetometers), and the like.

Communication may be implemented using a wide variety of technologies.The I/O components 918 may include communication components 940 operableto couple the machine 900 to a network 932 or devices 920 via coupling922 and coupling 924 respectively. For example, the communicationcomponents 940 may include a network interface component or othersuitable device to interface with the network 932. In further examples,communication components 940 may include wired communication components,wireless communication components, cellular communication components,Near Field Communication (NFC) components, Bluetooth® components (e.g.,Bluetooth® Low Energy), Wi-Fi® components, and other communicationcomponents to provide communication via other modalities. The devices920 may be another machine or any of a wide variety of peripheraldevices (e.g., a peripheral device coupled via a Universal Serial Bus(USB)).

Moreover, the communication components 940 may detect identifiers orinclude components operable to detect identifiers. For example, thecommunication components 940 may include Radio Frequency Identification(RFID) tag reader components, NFC smart tag detection components,optical reader components (e.g., an optical sensor to detectone-dimensional bar codes such as Universal Product Code (UPC) bar code,multi-dimensional bar codes such as Quick Response (QR) code, Azteccode, Data Matrix, Dataglyph, MaxiCode, PDF417, Ultra Code, UCC RSS-2Dbar code, and other optical codes), or acoustic detection components(e.g., microphones to identify tagged audio signals). In addition, avariety of information may be derived via the communication components940, such as, location via Internet Protocol (IP) geo-location, locationvia Wi-Fi® signal triangulation, location via detecting a NFC beaconsignal that may indicate a particular location, and so forth.

Where a phrase similar to “at least one of A, B, or C,” “at least one ofA, B, and C,” “one or more A, B, or C,” or “one or more of A, B, and C”is used, it is intended that the phrase be interpreted to mean that Aalone may be present in an embodiment, B alone may be present in anembodiment, C alone may be present in an embodiment, or that anycombination of the elements A, B and C may be present in a singleembodiment; for example, A and B, A and C, B and C, or A and B and C.

As used herein, the term “or” may be construed in either an inclusive orexclusive sense. Moreover, plural instances may be provided forresources, operations, or structures described herein as a singleinstance. Additionally, boundaries between various resources,operations, modules, engines, and data stores are somewhat arbitrary,and particular operations are illustrated in a context of specificillustrative configurations. Other allocations of functionality areenvisioned and may fall within a scope of various embodiments of thepresent disclosure. In general, structures and functionality presentedas separate resources in the example configurations may be implementedas a combined structure or resource. Similarly, structures andfunctionality presented as a single resource may be implemented asseparate resources. These and other variations, modifications,additions, and improvements fall within a scope of embodiments of thepresent disclosure as represented by the appended claims. Thespecification and drawings are, accordingly, to be regarded in anillustrative rather than a restrictive sense.

1. A system comprising: a processor; and memory coupled to the processorand storing instructions that, when executed by the processor, cause thesystem to perform operations comprising: receiving, from a clientcomputing device over a network, a request to perform a service;retrieving a configuration file stored in the memory; identifying aplurality of nodes within the configuration file, each respective nodein the plurality of nodes comprising a respective set of parametersassociated with the service, wherein the plurality of nodes includes anobject node identifying an object component used in performing theservice, and the object component includes an update mapping node thatincludes parameters associated with a response to the request;identifying, based on the parameters associated with the service, acustomized extension associated with the service; performing the serviceusing the customized extension; generating the response to the requestto perform the service, wherein the response is formatted based on theparameters in the update mapping node; and transmitting the response tothe request to perform the service to the client computing device overthe network.
 2. The system of claim 1, wherein the plurality of nodesincludes a feature node identifying an application program interface(API) to be used in conjunction with performing the service. 3.(canceled)
 4. The system of claim 1, wherein the object componentfurther includes a query node that includes information for performing aquery for an attribute of the object component.
 5. The system of claim4, wherein the information for performing the query includes objectquery language (OQL) for performing the query.
 6. The system of claim 5,wherein the memory further stores instructions for causing the systemto: present a user interface on a display screen of the client computingdevice; receiving user input via the user interface, the user inputincluding OQL for performing the query; and storing the OQL forperforming the query within the query node in the configuration file. 7.The system of claim 4, wherein the object component further includes aparameter node that includes parameters for performing the query for theattribute.
 8. The system of claim 7, wherein the memory further storesinstructions for causing the system to: present a user interface on adisplay screen of the client computing device; receiving user input viathe user interface, the user input including the parameters forperforming the query; and storing the parameters for performing thequery within the parameter node in the configuration file.
 9. The systemof claim 4, wherein the object component further includes a mapping nodethat includes parameters associated with the request to perform theservice.
 10. (canceled)
 11. The system of claim 1, wherein theconfiguration file comprises an identifier for an object and validationparameters for the object, and wherein performing the service includesvalidating the object based on the validation parameters.
 12. The systemof claim 11, wherein the object is an account, and wherein thevalidation parameters include an account identifier and addressinformation associated with the account.
 13. The system of claim 12,wherein the validation parameters include a mapping node that includesparameters associated with a request to validate the account.
 14. Thesystem of claim 12, wherein the validation parameters include an updatemapping node that includes parameters associated with a response to therequest to validate the account.
 15. The system of claim 11, wherein thememory further stores instructions for causing the system to: present auser interface on a display screen of the client computing device;receiving user input via the user interface, the user input includingthe identifier for the object; generating the validation parameters forthe object based on the object identifier; and storing the objectidentifier and the validation parameters for the object in theconfiguration file.
 16. The system of claim 1, wherein the memoryfurther stores instructions for causing the system to: present a userinterface on a display screen of the client computing device; receivinguser input via the user interface, the user input including anidentifier for customized extension; and storing the customizedextension identifier in the configuration file.
 17. The system of claim1, wherein the memory further stores instructions for causing the systemto: present a user interface on a display screen of the client computingdevice, the user interface including an identifier for a hook associatedwith the service; receiving user input via the user interface, the userinput including a definition for the customized extension; and storingthe definition for the customized extension in the configuration file.18. The system of claim 1, wherein performing the service includes:executing a first process associated with the service; and executing asecond process associated with the customized extension.
 19. A methodcomprising: receiving, by a computer system from a client computingdevice over a network, a request to perform a service; retrieving, bythe computer system, a configuration file stored in memory coupled tothe computer system; identifying, by the computer system, a plurality ofnodes within the configuration file, each respective node in theplurality of nodes comprising a respective set of parameters associatedwith the service, wherein the plurality of nodes includes an object nodeidentifying an object component used in performing the service, and theobject component includes an update mapping node that includesparameters associated with a response to the request; identifying, bythe computer system and based on the parameters associated with theservice, a customized extension associated with the service; performingthe service, by the computer system, using the customized extension;generating, by the computer system, the response to the request toperform the service, wherein the response is formatted based on theparameters in the update mapping node; and transmitting, by the computersystem, the response to the request to perform the service to the clientcomputing device over the network.
 20. A non-transitorycomputer-readable medium storing instructions that, when executed by acomputer system, cause the computer system to perform operationscomprising: receiving, from a client computing device over a network, arequest to perform a service; retrieving a configuration file stored inmemory coupled to the computer system; identifying a plurality of nodeswithin the configuration file, each respective node in the plurality ofnodes comprising a respective set of parameters associated with theservice, wherein the plurality of nodes includes an object nodeidentifying an object component used in performing the service, and theobject component includes an update mapping node that includesparameters associated with a response to the request; identifying, basedon the parameters associated with the service, a customized extensionassociated with the service; performing the service using the customizedextension; generating the response to the request to perform theservice, wherein the response is formatted based on the parameters inthe update mapping node; and transmitting the response to the request toperform the service to the client computing device over the network.